Создать триггер для Cloud Logging, который вызывает функцию Cloud Functions

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

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

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

yc serverless trigger create logging \
  --name <имя_триггера> \
  --log-group-name <имя_лог-группы> \
  --batch-size <размер_группы_сообщений> \
  --batch-cutoff <максимальное_время_ожидания> \
  --resource-ids <идентификатор_ресурса> \
  --resource-types <тип_ресурса> \
  --stream-names <поток_логирования> \
  --log-levels <уровень_логирования> \
  --invoke-function-id <идентификатор_функции> \
  --invoke-function-service-account-id <идентификатор_сервисного_аккаунта> \
  --retry-attempts <количество_повторных_вызовов> \
  --retry-interval <интервал_между_повторными_вызовами> \
  --dlq-queue-id <идентификатор_очереди_Dead_Letter_Queue> \
  --dlq-service-account-id <идентификатор_сервисного_аккаунта>

Где:

• --name — имя триггера.
• --log-group-name — имя лог-группы, при добавлении записей в которую будет вызываться функция.

• --batch-size — размер группы сообщений. Необязательный параметр. Допустимые значения от 1 до 10, значение по умолчанию — 1.
• --batch-cutoff — максимальное время ожидания. Необязательный параметр. Допустимые значения от 1 до 60 секунд, значение по умолчанию — 1 секунда. Триггер группирует сообщения не дольше batch-cutoff и отправляет их в функцию. Число сообщений при этом не превышает batch-size.

• --resource-ids — идентификаторы ваших ресурсов или ресурсов Yandex Cloud, например функций Cloud Functions. Необязательный параметр.
• --resource-types — типы ресурсов, например функции Cloud Functions serverless.function. Необязательный параметр.
• --stream-names — потоки логирования. Необязательный параметр.
• --log-levels — уровни логирования. Необязательный параметр.
  Триггер срабатывает, когда в указанную лог-группу добавляют записи, которые соответствуют всем следующим параметрам: resource-ids, resource-types, stream-names и log-levels. Если параметр не задан, триггер срабатывает при любом его значении.

• --invoke-function-id — идентификатор функции.
• --invoke-function-service-account-id — идентификатор сервисного аккаунта с правами на вызов функции.
• --retry-attempts — количество повторных вызовов, которые будут сделаны, прежде чем триггер отправит сообщение в Dead Letter Queue. Необязательный параметр. Допустимые значения — от 1 до 5, значение по умолчанию — 1.
• --retry-interval — время, через которое будет сделан повторный вызов функции, если текущий завершился неуспешно. Необязательный параметр. Допустимые значения — от 10 до 60 секунд, значение по умолчанию — 10 секунд.
• --dlq-queue-id — идентификатор очереди Dead Letter Queue. Необязательный параметр.
• --dlq-service-account-id — идентификатор сервисного аккаунта с правами на запись в очередь Dead Letter Queue. Необязательный параметр.

Результат:

id: a1sfe084v4**********
folder_id: b1g88tflru**********
created_at: "2019-12-04T08:45:31.131391Z"
name: logging-trigger
rule:
  logging:
    log-group-name: default
    resource_type:
      - serverless.functions
    resource_id:
      - d4e1gpsgam78********
    stream_name:
      - test
    levels:
      - INFO
    batch_settings:
      size: "1"
      cutoff: 1s
    invoke_function:
      function_id: d4eofc7n0m**********
      function_tag: $latest
      service_account_id: aje3932acd**********
      retry_settings:
        retry_attempts: "1"
        interval: 10s
      dead_letter_queue:
        queue-id: yrn:yc:ymq:ru-central1:aoek49ghmk**********:dlq
        service-account-id: aje3932a**********
status: ACTIVE

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

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

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

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

Чтобы создать триггер для Cloud Logging:

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

   resource "yandex_function_trigger" "my_trigger" {
     name        = "<имя_триггера>"
     description = "<описание_триггера>"
     function {
        id                 = "<идентификатор_функции>"
        service_account_id = "<идентификатор_сервисного_аккаунта>"
        retry_attempts     = "<количество_повторных_вызовов>"
        retry_interval     = "<интервал_между_повторными_вызовами>"
     }
     logging {
        group_id       = "<идентификатор_лог-группы>"
        resource_types = [ "<тип_ресурса>" ]
        resource_ids   = [ "<идентификатор_ресурса>" ]
        stream_names   = [ "<поток_логирования>" ]
        levels         = [ "<уровень_логирования>", "<уровень_логирования>" ]
        batch_cutoff   = "<максимальное_время_ожидания>"
        batch_size     = "<размер_группы_сообщений>"
     }
     dlq {
       queue_id           = "<идентификатор_очереди_Dead_Letter_Queue>"
       service_account_id = "<идентификатор_сервисного_аккаунта>"
     }
   }
   

   Где:

   • name — имя триггера. Формат имени:

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

   • description — описание триггера.

   • function — параметры функции:

     • id — идентификатор функции.
     • service_account_id — идентификатор сервисного аккаунта с правами на вызов функции.
     • retry_attempts — количество повторных вызовов, которые будут сделаны, прежде чем триггер отправит сообщение в Dead Letter Queue. Необязательный параметр. Допустимые значения — от 1 до 5, значение по умолчанию — 1.
     • retry_interval — время, через которое будет сделан повторный вызов функции, если текущий завершился неуспешно. Необязательный параметр. Допустимые значения — от 10 до 60 секунд, значение по умолчанию — 10 секунд.

   • logging — параметры триггера:

     • group_id — идентификатор лог-группы, при добавлении записей в которую будет вызываться функция.

     • resource_types — типы ресурсов, например функции Cloud Functions resource_types = [ "serverless.function" ]. Можно указать сразу несколько типов.

     • resource_ids — идентификаторы ваших ресурсов или ресурсов Yandex Cloud, например функций resource_ids = [ "<идентификатор_функции>" ]. Вы можете указать несколько идентификаторов.

     • stream_names — потоки логирования. Необязательный параметр.

     • levels — уровни логирования. Например, levels = [ "INFO", "ERROR"].

       Триггер срабатывает, когда в указанную лог-группу добавляют записи, которые соответствуют всем следующим параметрам: resource-ids, resource-types, stream-names и levels. Если параметр не задан, триггер срабатывает при любом его значении.

     • batch_cutoff — максимальное время ожидания. Допустимые значения от 0 до 60 секунд. Триггер группирует сообщения не дольше указанного времени ожидания и отправляет их в функцию. Число сообщений при этом не превышает указанный размер группы batch-size.

     • batch_size — размер группы сообщений. Допустимые значения от 1 до 10.

   • dlq — параметры очереди сообщений Dead Letter Queue:
     • queue_id — идентификатор очереди Dead Letter Queue. Необязательный параметр.
     • service_account_id — идентификатор сервисного аккаунта с правами на запись в очередь Dead Letter Queue. Необязательный параметр.

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

2. Создайте ресурсы:

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

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

      terraform validate
      

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

      Success! The configuration is valid.
      

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

      terraform plan
      

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

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

      terraform apply
      

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

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

   yc serverless trigger list
   

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