Записать логи в журнал выполнения в API Gateway

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

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

Назначение логированияНазначение логирования

Если в параметрах API-шлюза не указана пользовательская лог-группа или логирование не отключено, API-шлюз автоматически пишет все логи в лог-группу по умолчанию для каталога, в котором он находится.

Чтобы записывать логи в лог-группу по умолчанию для другого каталога, укажите идентификатор этого каталога в параметре --log-folder-id при создании или изменении API-шлюза. Аккаунту, от имени которого выполняется команда, на этот каталог должна быть назначена роль logging.editor или выше.

Чтобы записывать логи в пользовательскую лог-группу, укажите идентификатор этой лог-группы в параметре --log-group-id при создании или изменении API-шлюза. Лог-группа может находиться в другом каталоге. Аккаунту, от имени которого выполняется команда, на этот каталог должна быть назначена роль logging.editor или выше.

Минимальный уровень логированияМинимальный уровень логирования

Чтобы задать минимальный уровень логирования, укажите его в параметре --min-log-level при создании или изменении API-шлюза.

Если минимальный уровень логирования задан, в журнал выполнения записываются логи указанного уровня и выше. Если минимальный уровень логирования не задан, в журнал выполнения записываются все логи API-шлюза.

Отключение логированияОтключение логирования

Чтобы отключить логирование, при создании или изменении API-шлюза укажите параметр --no-logging.

Пример командыПример команды

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

yc serverless api-gateway update <имя_или_идентификатор_API-шлюза> \
  --log-group-id <идентификатор_лог-группы> \
  --min-log-level <минимальный_уровень_логирования>

Где:

• --log-group-id — идентификатор лог-группы, в которую будут записываться логи.
• --min-log-level — минимальный уровень логирования. Доступные уровни логирования: TRACE, DEBUG, INFO, WARN, ERROR и FATAL. Необязательный параметр.

Результат:

id: d5dr8k465604********
folder_id: b1g3f9i71bpm********
created_at: "2024-01-26T09:18:55.985Z"
name: example_gateway
status: ACTIVE
domain: d5dm1lba80md********.i9******.apigw.yandexcloud.net
log_group_id: ckgsh1kdbvj1********
connectivity: {}
log_options:
  log_group_id: e23u2vn449av********
  min_level: ERROR

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

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

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

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

Назначение логированияНазначение логирования

Если в параметрах API-шлюза не указана пользовательская лог-группа или логирование не отключено, API-шлюз автоматически пишет все логи в лог-группу по умолчанию для каталога, в котором он находится.

Чтобы записывать логи в лог-группу по умолчанию для другого каталога, укажите идентификатор этого каталога в блоке log_options в параметре folder_id при создании или изменении API-шлюза. Аккаунту, от имени которого выполняется команда, на этот каталог должна быть назначена роль logging.editor или выше.

Чтобы записывать логи в пользовательскую лог-группу, укажите идентификатор этой лог-группы в блоке log_options в параметре log_group_id при создании или изменении API-шлюза. Лог-группа может находиться в другом каталоге. Аккаунту, от имени которого выполняется команда, на этот каталог должна быть назначена роль logging.editor или выше.

Минимальный уровень логированияМинимальный уровень логирования

Чтобы задать минимальный уровень логирования, укажите его в блоке log_options в параметре min_level при создании или изменении API-шлюза.

Если минимальный уровень логирования задан, в журнал выполнения записываются логи указанного уровня и выше. Если минимальный уровень логирования не задан, в журнал выполнения записываются все логи API-шлюза.

Отключение логированияОтключение логирования

Чтобы отключить логирование, при создании или изменении API-шлюза в блоке log_options укажите параметр disabled со значением true.

ПримерПример

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

1. Откройте файл конфигурации Terraform и добавьте к описанию ресурса yandex_api_gateway блок log_options:

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

   resource "yandex_api_gateway" "<имя_API-шлюза>" {
     ...
     log_options {
       folder_id = "<идентификатор_каталога>"
       min_level = "<минимальный_уровень_логирования>"
     }
     ...
   }
   

   Где:

   • folder_id — идентификатор каталога.
   • min_level — минимальный уровень логирования. Доступные уровни логирования: TRACE, DEBUG, INFO, WARN, ERROR и FATAL. Необязательный параметр.

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

2. Проверьте конфигурацию командой:

   terraform validate
   

   Если конфигурация является корректной, появится сообщение:

   Success! The configuration is valid.
   

3. Выполните команду:

   terraform plan
   

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

4. Примените изменения конфигурации:

   terraform apply
   

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

Чтобы записывать логи в журнал выполнения в Yandex API Gateway воспользуйтесь методом REST API update для ресурса ApiGateway или вызовом gRPC API ApiGatewayService/Update.