Создать триггер для Message Queue, который передает сообщения в функцию Cloud Functions
Создайте триггер для очереди сообщений сервиса Message Queue и обрабатывайте их с помощью функции Cloud Functions.
Важно
- Триггер можно создать только для стандартной очереди сообщений.
- Триггер должен находиться в одном облаке с очередью, из которой он читает сообщения.
- Для одной очереди сообщений можно создать только один триггер.
Перед началом работы
Для создания триггера вам понадобятся:
-
Функция, которую триггер будет вызывать. Если у вас нет функции:
-
Сервисные аккаунты с правами:
- на вызов функции;
- на чтение из очереди, из которой триггер будет принимать сообщения.
Вы можете использовать один и тот же сервисный аккаунт или разные. Если у вас нет сервисного аккаунта, создайте его.
-
Очередь сообщений, из которой триггер будет принимать сообщения. Если у вас нет очереди, создайте ее.
Создать триггер
Примечание
Триггер начинает работать в течение 5 минут после создания.
-
В консоли управления
перейдите в каталог, в котором хотите создать триггер. -
Выберите сервис Cloud Functions.
-
На панели слева выберите
Триггеры. -
Нажмите кнопку Создать триггер.
-
В блоке Базовые параметры:
- Введите имя и описание триггера.
- В поле Тип выберите Message Queue.
- В поле Запускаемый ресурс выберите Функция.
-
В блоке Настройки сообщений Message Queue выберите очередь сообщений и сервисный аккаунт с правами на чтение из нее.
-
В блоке Настройки группирования сообщений укажите:
- Время ожидания, с. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд.
- Размер группы. Допустимые значения от 1 до 1000, значение по умолчанию — 1.
Триггер группирует сообщения не дольше указанного времени ожидания и отправляет их в функцию. Число сообщений при этом не превышает указанный размер группы.
-
В блоке Настройки функции выберите функцию и укажите:
- Тег версии функции.
- Сервисный аккаунт, от имени которого будет вызываться функция.
-
Нажмите кнопку Создать триггер.
Если у вас еще нет интерфейса командной строки 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 <размер_группы_сообщений> \
--batch-cutoff <максимальное_время_ожидания>
Где:
-
--name
— имя триггера. -
--queue
— идентификатор очереди.Чтобы узнать идентификатор очереди:
- В консоли управления
перейдите в каталог, в котором находится очередь. - Выберите сервис Message Queue.
- Выберите очередь.
- Идентификатор очереди будет в блоке Общая информация, в поле ARN.
- В консоли управления
-
--invoke-function-id
— идентификатор функции. -
--queue-service-account-name
— идентификатор сервисного аккаунта с правами на чтение из очереди сообщений. -
--invoke-function-service-account-id
— идентификатор сервисного аккаунта с правами на вызов функции. -
--batch-size
— размер группы сообщений. Необязательный параметр. Допустимые значения от 1 до 1000, значение по умолчанию — 1. -
--batch-cutoff
— максимальное время ожидания. Необязательный параметр. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд. Триггер группирует сообщения не дольшеbatch-cutoff
и отправляет их в функцию. Число сообщений при этом не превышаетbatch-size
.
Результат:
id: dd0cspdch6**********
folder_id: aoek49ghmk**********
created_at: "2019-08-28T12:14:45.762915Z"
name: ymq-trigger
rule:
message_queue:
queue_id: yrn:yc:ymq:ru-central1:aoek49ghmk**********:my-mq
service_account_id: bfbqqeo6jk**********
batch_settings:
size: "1"
cutoff: 10s
invoke_function:
function_id: b09e5lu91t**********
function_tag: $latest
service_account_id: bfbqqeo6j**********
status: ACTIVE
Terraform
Terraform распространяется под лицензией Business Source License
Подробную информацию о ресурсах провайдера смотрите в документации на сайте Terraform
Если у вас еще нет Terraform, установите его и настройте провайдер Yandex Cloud.
Чтобы создать триггер для Message Queue:
-
Опишите в конфигурационном файле параметры триггера:
resource "yandex_function_trigger" "my_trigger" { name = "<имя_триггера>" description = "<описание_триггера>" function { id = "<идентификатор_функции>" service_account_id = "<идентификатор_сервисного_аккаунта>" } message_queue { queue_id = "<идентификатор_очереди>" service_account_id = "<идентификатор_сервисного_аккаунта>" batch_size = "<размер_группы_сообщений>" batch_cutoff = "<максимальное_время_ожидания>" }
Где:
-
name
— имя триггера. Формат имени:- длина — от 3 до 63 символов;
- может содержать строчные буквы латинского алфавита, цифры и дефисы;
- первый символ — буква, последний — не дефис.
-
description
— описание триггера. -
function
— параметры функции:id
— идентификатор функции.service_account_id
— идентификатор сервисного аккаунта с правами на вызов функции.
-
message_queue
— параметры триггера:-
queue_id
— идентификатор очереди сообщений.Чтобы узнать идентификатор очереди:
- В консоли управления
перейдите в каталог, в котором находится очередь. - Выберите сервис Message Queue.
- Выберите очередь.
- Идентификатор очереди будет в блоке Общая информация, в поле ARN.
- В консоли управления
-
service_account_id
— идентификатор сервисного аккаунта с правами на чтение из очереди сообщений. -
batch_size
— размер группы сообщений. Необязательный параметр. Допустимые значения от 1 до 1000, значение по умолчанию — 1. -
batch_cutoff
— максимальное время ожидания. Необязательный параметр. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд. Триггер группирует сообщения не дольшеbatch-cutoff
и отправляет их в функцию. Число сообщений при этом не превышаетbatch-size
.
-
Более подробную информацию о параметрах ресурса
yandex_function_trigger
см. в документации провайдера . -
-
Создайте ресурсы:
-
В терминале перейдите в папку, где вы отредактировали конфигурационный файл.
-
Проверьте корректность конфигурационного файла с помощью команды:
terraform validate
Если конфигурация является корректной, появится сообщение:
Success! The configuration is valid.
-
Выполните команду:
terraform plan
В терминале будет выведен список ресурсов с параметрами. На этом этапе изменения не будут внесены. Если в конфигурации есть ошибки, Terraform на них укажет.
-
Примените изменения конфигурации:
terraform apply
-
Подтвердите изменения: введите в терминале слово
yes
и нажмите Enter.
Terraform создаст все требуемые ресурсы. Проверить появление ресурсов можно в консоли управления
или с помощью команды CLI:yc serverless trigger list
-
Чтобы создать триггер для Yandex Message Queue, воспользуйтесь методом REST API create для ресурса Trigger или вызовом gRPC API TriggerService/Create.
Проверить результат
Проверьте, что триггер работает корректно. Для этого посмотрите логи функции, в них отображается информация о вызовах.
Проверьте, что количество сообщений в очереди уменьшается. Для этого посмотрите статистику очереди:
- В консоли управления
выберите сервис Message Queue. - Выберите очередь, для которой создали триггер.
- Перейдите в раздел Мониторинг. Посмотрите график Сообщений в очереди.