Updating a log group

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

The folder specified in the CLI profile is used by default. You can specify a different folder through the --folder-name or --folder-id parameter.

To access a log group, use its name or unique ID. To find them, get a list of log groups in the folder.

To edit log group parameters, such as the record retention period, run this command:

yc logging group update --name=default --retention-period=24h

Where:

• --name: Name of the log group whose record retention period you want to update.

• --retention-period: New retention period for log group records.

  The record retention period can only be specified in hours, minutes, or seconds. For example, 1h or 1440m.

Result:

id: af3mu6hnd0**********
folder_id: aoek6qrs8t**********
cloud_id: aoegtvhtp8**********
created_at: "2023-06-22T09:51:43.614Z"
name: default
status: ACTIVE
retention_period: 86400s

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To edit parameters of a log group created with Terraform:

1. Open the Terraform configuration file and edit the required parameter, such as the record retention period, in the log group description:

   ...
   resource "yandex_logging_group" "group1" {
     name             = "test-logging-group"
     folder_id        = "<folder_ID>"
     retention_period = "5h"
   }
   ...
   

   Where:

   • name: Log group name. This is an optional parameter.

   • folder_id: Folder ID. This is an optional parameter. By default, the value specified in the provider settings is used.

   • retention_period: New retention period for log group records.

     The record retention period can only be specified in hours, minutes, or seconds. For example, 1h or 1440m.

   For more information about the yandex_logging_group parameters in Terraform, see the relevant Terraform article.

2. Check the configuration using this command:

   terraform validate
   

   If the configuration is correct, you will get this message:

   Success! The configuration is valid.
   

3. Run this command:

   terraform plan
   

   The terminal will display a list of resources with their parameters. No changes will be made at this step. If the configuration contains any errors, Terraform will point them out.

4. Apply the configuration changes:

   terraform apply
   

5. Confirm the changes: type yes into the terminal and press Enter.

   You can check the log group update in the management console or using this CLI command:

   yc logging group get <log_group_name>
   

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

Request example

The example below uses the grpcurl utility. To use the example, authenticate in the API and clone the cloudapi repository.

In the example, the record retention period is updated.

Create a file named payload.json:

{
   "log_group_id": "<log_group_ID>",
   "retention_period": "24h",
   "update_mask": {
      "paths": ["retention_period"]
   }
}

Run 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.Update < payload.json

Response:

{
  "id": "e23omac87b3a********",
  "description": "Update log group",
  "createdAt": "2023-03-25T05:39:24.058608338Z",
  "createdBy": "ajego134p5h1********",
  "modifiedAt": "2023-03-25T05:39:24.058608338Z",
  "metadata": {
    "@type": "type.googleapis.com/yandex.cloud.logging.v1.UpdateLogGroupMetadata",
    "logGroupId": "e23ff0on5amv********"
  }
}