Creating a log group

If you do not have the Yandex Cloud CLI installed yet, install and initialize it.

By default, the CLI uses the folder specified when creating the profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also set a different folder for any specific command using the --folder-name or --folder-id parameter.

To create a log group, run this command:

yc logging group create \
  --name=group \
  --retention-period=1h \
  --data-stream=<stream_ID>

Where:

• --name: Log group name.

• --retention-period: Retention period for log group records. This is an optional setting.

  You can only set the record retention period in hours, minutes, or seconds, e.g., 1h or 1440m.

• --data-stream: Data stream ID in Yandex Data Streams. This is an optional setting. The specified stream will automatically receive the records added to your log group. A stream ID comprises the availability zone, folder ID, Yandex Managed Service for YDB database ID, and stream name.

  For example, your stream ID will appear as /ru-central1/aoeu1kuk2dht********/cc8029jgtuab********/aws_stream if:

  • aws_stream: Stream name.
  • ru-central1: Availability zone.
  • aoeu1kuk2dht********: Folder ID.
  • cc8029jgtuab********: Yandex Managed Service for YDB database ID.

Result:

done (1s)
id: af3flf29t8**********
folder_id: aoek6qrs8t**********
cloud_id: aoegtvhtp8**********
created_at: "2023-06-24T09:56:38.970Z"
name: group
status: ACTIVE
retention_period: 3600s
data_stream: /ru-central1/aoeu1kuk2dht********/cc8029jgtuab********/aws_stream

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it using configuration files. These files store the infrastructure description written in HashiCorp Configuration Language (HCL). If you change the configuration files, Terraform automatically detects which part of your configuration is already deployed, and what should be added or removed.

Terraform is distributed under the Business Source License. The Yandex Cloud provider for Terraform is distributed under the MPL-2.0 license.

For more information about the provider resources, see the relevant documentation on the Terraform website or its mirror.

If you do not have Terraform yet, install it and configure the Yandex Cloud provider.

1. In the configuration file, describe the resources you want to create:

   • name: Log group name. This is an optional setting. Follow these naming requirements:

     • It must be from 2 to 63 characters long.
     • It can only contain lowercase Latin letters, numbers, and hyphens.
     • It must start with a letter and cannot end with a hyphen.

   • folder_id: Folder ID. This is an optional setting. It defaults to the value defined by the provider.

   • retention_period: Retention period for log group records. This is an optional setting.

     You can only set the record retention period in hours, minutes, or seconds, e.g., 1h or 1440m.

   Here is an example of the configuration file structure:

   provider "yandex" {
     token     = "<OAuth_token>"
     cloud_id  = "<cloud_ID>"
     folder_id = "<folder_ID>"
     zone      = "ru-central1-a"
   }
   
   resource "yandex_logging_group" "group1" {
     name             = "<log_group_name>"
     folder_id        = "<folder_ID>"
     retention_period = "5h"
   }
   

   For more information about the yandex_logging_group settings, see this Terraform article.

2. Make sure the configuration files are correct.

   1. In the command line, navigate to the directory where you created the configuration file.

   2. Run a check using this command:

      terraform plan
      

   If you described the configuration correctly, the terminal will display a list of the resources being created and their settings. Terraform will show any errors found in the configuration.

3. Deploy the cloud resources.

   1. If the configuration has no errors, run this command:

      terraform apply
      

   2. Confirm creating the resources by typing yes in the terminal and pressing Enter.

   This will create all the resources you need in the specified folder. You can check the new resources and their settings using the management console or this CLI command:

   yc logging group list
   

To create a log group, use the create REST API method for the LogGroup resource or the LogGroupService/Create gRPC API call.

Request example

The example below uses grpcurl. To run this example, authenticate with the API and clone the cloudapi repository.

Create a file named payload.json:

{
   "folder_id": "<folder_ID>",
   "name": "new-group",
   "description": "Description of a log group created with grpcurl",
   "labels": {
     "compute": "instance-logging"
   }
}

Send this request:

grpcurl -rpc-header "Authorization: Bearer $(yc iam create-token)" \
  -d @ \
  -import-path ~/cloudapi/ \
  -import-path ~/cloudapi/third_party/googleapis/ \
  -proto ~/cloudapi/yandex/cloud/logging/v1/log_group_service.proto \
logging.api.cloud.yandex.net:443 yandex.cloud.logging.v1.LogGroupService.Create < payload.json

Response:

{
  "id": "e23nitus5cg9********",
  "description": "Create log group",
  "createdAt": "2023-11-23T14:54:23.077532292Z",
  "createdBy": "ajeugsk5ubk6********",
  "modifiedAt": "2023-11-23T14:54:23.077532292Z",
  "metadata": {
    "@type": "type.googleapis.com/yandex.cloud.logging.v1.CreateLogGroupMetadata",
    "logGroupId": "e23pjn86385t********"
  }
}