Подключиться
Yandex Cloud Functions

Создание триггера для Message Queue

Статья создана

Создайте триггер для очереди сообщений сервиса Yandex Message Queue и обрабатывайте их с помощью функции Cloud Functions.

Важно

  • Триггер должен находиться в одном облаке с очередью, из которой он читает сообщения.
  • Для одной очереди сообщений можно создать только один триггер.

Перед началом работы

Для создания триггера вам понадобятся:

  1. Функция, которой триггер будет передавать сообщения на обработку. Если у вас нет функции:
  2. Очередь сообщений, из которой триггер будет принимать сообщения. Если у вас нет очереди, создайте ее.
  3. Сервисные аккаунты с правами на чтение из очереди сообщений и вызов функции. Вы можете использовать один и тот же сервисный аккаунт или разные. Если у вас нет сервисного аккаунта, создайте его.

Создать триггер

Примечание

Триггер начинает работать в течение 5 минут после создания.

  1. В консоли управления перейдите в каталог, в котором хотите создать триггер.
  2. Откройте сервис Cloud Functions.
  3. Перейдите на вкладку Триггеры.
  4. Нажмите кнопку Создать триггер.
  5. В блоке Базовые параметры:
    • Введите имя и описание триггера.
    • В поле Тип выберите Message Queue.
  6. В блоке Настройки Message Queue выберите очередь сообщений и сервисный аккаунт c правами на чтение из нее.
  7. (опционально) В блоке Настройки группирования сообщений укажите:
    • размер группы сообщений. Допустимые значения от 1 до 10, значение по умолчанию — 1.
    • максимальное время ожидания. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд. Триггер отправит группу сообщений в функцию, когда число сообщений в очереди достигнет указанного размера группы или истечет максимальное время ожидания.
  8. В блоке Настройки функции:
    • Выберите функцию, которую будет вызывать триггер.
    • Укажите тег версии функции.
    • Укажите сервисный аккаунт, от имени которого будет вызываться функция.
  9. Нажмите кнопку Создать триггер.

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

По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.

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

yc serverless trigger create message-queue \
    --name <имя триггера> \
    --queue <идентификатор очереди> \
    --queue-service-account-id <идентификатор сервисного аккаунта> \
    --invoke-function-id <идентификатор функции> \
    --invoke-function-service-account-id <идентификатор сервисного аккаунта> \
    --batch-size 1 \
    --batch-cutoff 10s

где:

  • --name — имя триггера.
  • --queue — идентификатор очереди.
    Чтобы узнать идентификатор очереди:
    1. В консоли управления перейдите в каталог, в котором находится очередь.
    2. Откройте сервис Yandex Message Queue.
    3. Выберите очередь.
    4. Идентификатор очереди будет в блоке Общая информация, в поле ARN.
  • --invoke-function-id — идентификатор функции.
  • --queue-service-account-name — сервисный аккаунт с правами на чтение из очереди сообщений.
  • --invoke-function-service-account-id — сервисный аккаунт с правами на вызов функции.
  • --batch-size — размер группы сообщений. Необязательный параметр. Допустимые значения от 1 до 10, значение по умолчанию — 1.
  • --batch-cutoff — максимальное время ожидания. Необязательный параметр. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд. Триггер отправит группу сообщений в функцию, когда число сообщений в очереди достигнет batch-size или истечет batch-cutoff.

Результат:

id: dd0cspdch6dslu9n3i5g
folder_id: aoek49ghmknnpj1ll45e
created_at: "2019-08-28T12:14:45.762915Z"
name: ymq-trigger
rule:
  message_queue:
    queue_id: yrn:yc:ymq:ru-central1:aoek49ghmknnpj1ll45e:my-mq
    service_account_id: bfbqqeo6jkpls2tse5o6
    batch_settings:
      size: "1"
      cutoff: 10s
    invoke_function:
      function_id: b09e5lu91ta21vdrrgma
      function_tag: $latest
      service_account_id: bfbqqeo6jkpls2tse5o6  
status: ACTIVE

Создать триггер для Yandex Message Queue можно с помощью метода API create.

Проверить результат

Проверьте, что триггер работает корректно. Для этого посмотрите логи функции, в них отображается информация о ее вызовах.

Проверьте, что количество сообщений в очереди уменьшается. Для этого посмотрите статистику очереди:

  1. Откройте сервис Message Queue.
  2. Выберите очередь, для которой создали триггер.
  3. Перейдите в раздел Мониторинг. Посмотрите график Сообщений в очереди.
В этой статье: