Создать лог-группу

Если у вас еще нет интерфейса командной строки Yandex Cloud (CLI), установите и инициализируйте его.

По умолчанию используется каталог, указанный при создании профиля CLI. Чтобы изменить каталог по умолчанию, используйте команду yc config set folder-id <идентификатор_каталога>. Также для любой команды вы можете указать другой каталог с помощью параметров --folder-name или --folder-id.

Чтобы создать лог-группу, выполните команду:

yc logging group create \
  --name=group \
  --retention-period=1h \
  --data-stream=<идентификатор_потока>

Где:

• --name — имя лог-группы.

• --retention-period — срок хранения записей в лог-группе. Необязательный параметр.

  Срок хранения записей можно указать только в часах, минутах или секундах. Например, 1h или 1440m.

• --data-stream — идентификатор потока данных Yandex Data Streams. Необязательный параметр. В указанный поток автоматически будут перенаправляться записи, которые добавили в лог-группу. Идентификатор потока состоит из зоны доступности, идентификатора каталога, идентификатора базы данных Yandex Managed Service for YDB и имени потока.

  Например, укажите идентификатор потока /kz1/aoeu1kuk2dht********/cc8029jgtuab********/aws_stream, если:

  • aws_stream — имя потока;
  • kz1 — зона доступности;
  • aoeu1kuk2dht******** — идентификатор каталога;
  • cc8029jgtuab******** — идентификатор базы данных Yandex Managed Service for YDB.

  Важно

  Функциональность доступна только в регионе Россия.

Результат:

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: /kz1/aoeu1kuk2dht********/cc8029jgtuab********/aws_stream

Terraform позволяет быстро создать облачную инфраструктуру в Yandex Cloud и управлять ею с помощью файлов конфигураций. В файлах конфигураций хранится описание инфраструктуры на языке HCL (HashiCorp Configuration Language). При изменении файлов конфигураций Terraform автоматически определяет, какая часть вашей конфигурации уже развернута, что следует добавить или удалить.

Terraform распространяется под лицензией Business Source License, а провайдер Yandex Cloud для Terraform — под лицензией MPL-2.0.

Подробную информацию о ресурсах провайдера смотрите в документации на сайте Terraform или в зеркале.

Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.

1. Опишите в конфигурационном файле параметры ресурсов, которые необходимо создать:

   • name — имя лог-группы. Необязательный параметр. Формат имени:

     • длина — от 2 до 63 символов;
     • может содержать строчные буквы латинского алфавита, цифры и дефисы;
     • первый символ — буква, последний — не дефис.

   • folder_id — идентификатор каталога. Необязательный параметр. По умолчанию будет использовано значение, указанное в настройках провайдера.

   • retention_period — срок хранения записей в лог-группе. Необязательный параметр.

     Срок хранения записей можно указать только в часах, минутах или секундах. Например, 1h или 1440m.

   Пример структуры конфигурационного файла:

   provider "yandex" {
     token     = "<OAuth-токен>"
     cloud_id  = "<идентификатор_облака>"
     folder_id = "<идентификатор_каталога>"
     zone      = "kz1-a"
   }
   
   resource "yandex_logging_group" "group1" {
     name             = "<имя_лог-группы>"
     folder_id        = "<идентификатор_каталога>"
     retention_period = "5h"
   }
   

   Более подробную информацию о параметрах ресурса yandex_logging_group в Terraform, см. в документации провайдера.

2. Проверьте корректность конфигурационных файлов.

   1. В командной строке перейдите в папку, где вы создали конфигурационный файл.

   2. Выполните проверку с помощью команды:

      terraform plan
      

   Если конфигурация описана верно, в терминале отобразится список создаваемых ресурсов и их параметров. Если в конфигурации есть ошибки, Terraform на них укажет.

3. Разверните облачные ресурсы.

   1. Если в конфигурации нет ошибок, выполните команду:

      terraform apply
      

   2. Подтвердите создание ресурсов: введите в терминал слово yes и нажмите Enter.

   После этого в указанном каталоге будут созданы все требуемые ресурсы. Проверить появление ресурсов и их настройки можно в консоли управления или с помощью команды CLI:

   yc logging group list
   

Чтобы создать лог-группу, воспользуйтесь методом REST API create для ресурса LogGroup или вызовом gRPC API LogGroupService/Create.

Пример запроса

Пример использования написан с помощью утилиты grpcurl. Чтобы воспользоваться им, аутентифицируйтесь в API и клонируйте репозиторий cloudapi.

Создайте файл payload.json:

{
   "folder_id": "<идентификатор_каталога>",
   "name": "new-group",
   "description": "Описание лог-группы, созданной с помощью grpcurl",
   "labels": {
     "compute": "instance-logging"
   }
}

Выполните запрос:

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.yandexcloud.kz:443 yandex.cloud.logging.v1.LogGroupService.Create < payload.json

Ответ:

{
  "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********"
  }
}