Создать триггер для Message Queue, который отправляет сообщения в WebSocket-соединения
Создайте триггер для очереди сообщений сервиса Message Queue, который будет отправлять сообщения в WebSocket-соединения.
Важно
- Триггер можно создать только для стандартной очереди сообщений.
- Триггер должен находиться в одном облаке с очередью, из которой он читает сообщения.
- Для одной очереди сообщений можно создать только один триггер.
Перед началом работы
Для создания триггера вам понадобятся:
-
API-шлюз. Сообщения будут отправляться в WebSocket-соединения, подключенные к API-шлюзу. Если у вас нет API-шлюза, создайте его.
-
Сервисный аккаунт с ролью
api-gateway.websocketBroadcaster. Если у вас нет сервисного аккаунта, создайте его.
- Очередь сообщений, из которой триггер будет принимать сообщения. Если у вас нет очереди, создайте ее.
Создать триггер
Примечание
Триггер начинает работать в течение 5 минут после создания.
-
В консоли управления перейдите в каталог, в котором хотите создать триггер.
-
Откройте сервис API Gateway.
-
На панели слева выберите Триггеры.
-
Нажмите кнопку Создать триггер.
-
В блоке Базовые параметры:
- Введите имя и описание триггера.
- В поле Тип выберите
Message Queue. - В поле Запускаемый ресурс выберите
API-шлюз.
-
В блоке Настройки сообщений Message Queue выберите очередь сообщений и сервисный аккаунт с правами на чтение из нее.
-
В блоке Настройки группирования сообщений укажите:
- размер группы сообщений. Допустимые значения от 1 до 1000, значение по умолчанию — 1.
- максимальное время ожидания. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд.
Триггер группирует сообщения не дольше указанного времени ожидания и отправляет их в WebSocket-соединения. Число сообщений при этом не превышает указанный размер группы.
-
В блоке Настройки API-шлюза:
- В поле API-шлюз выберите API-шлюз.
- В поле Путь укажите путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
- В поле Сервисный аккаунт выберите сервисный аккаунт, от имени которого в WebSocket-соединения будут отправляться сообщения.
-
Нажмите кнопку Создать триггер.
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --folder-name или --folder-id.
Чтобы создать триггер, который отправляет сообщения в WebSocket-соединения, выполните команду:
yc serverless trigger create message-queue \
--name <имя_триггера> \
--queue <идентификатор_очереди> \
--queue-service-account-id <идентификатор_сервисного_аккаунта> \
--gateway-id <идентификатор_API-шлюза> \
--gateway-websocket-broadcast-path <путь> \
--gateway-websocket-broadcast-service-account-id <идентификатор_сервисного_аккаунта> \
--batch-size <размер_группы_сообщений>
--batch-cutoff <максимальное_время_ожидания>
Где:
-
--name— имя триггера. -
--queue— идентификатор очереди.Чтобы узнать идентификатор очереди:
- В консоли управления перейдите в каталог, в котором находится очередь.
- Выберите сервис Message Queue.
- Выберите очередь.
- Идентификатор очереди будет в блоке Общая информация, в поле ARN.
-
--queue-service-account-id— сервисный аккаунт с правами на чтение из очереди сообщений.
--gateway-id— идентификатор API-шлюза.--gateway-websocket-broadcast-path— путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.--gateway-websocket-broadcast-account-id— идентификатор сервисного аккаунта с правами на отправку сообщений в WebSocket-соединения.
--batch-size— размер группы сообщений. Необязательный параметр. Допустимые значения от 1 до 1000, значение по умолчанию — 1.--batch-cutoff— максимальное время ожидания. Необязательный параметр. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд. Триггер группирует сообщения не дольшеbatch-cutoffи отправляет их в WebSocket-соединения. Число сообщений при этом не превышаетbatch-size.
Результат:
id: a1s5msktijh2********
folder_id: b1gmit33hgh2********
created_at: "2022-10-24T15:19:15.353909857Z"
name: ymq-trigger
rule:
message_queue:
queue_id: yrn:yc:ymq:ru-central1:b1gmit33ngh2********:my-mq
service_account_id: bfbqqeo6jkh2********
batch_settings:
size: "1"
cutoff: 10s
gateway_websocket_broadcast:
gateway_id: d4eofc7n0mh2********
path: /
service_account_id: aje3932acdh2********
status: ACTIVE
Чтобы создать триггер для Message Queue, воспользуйтесь методом REST API create для ресурса Trigger или вызовом gRPC API TriggerService/Create.
Проверить результат
Проверьте, что триггер работает корректно. Для этого посмотрите логи API-шлюза, в них отображается информация об обращениях к нему.
Проверьте, что количество сообщений в очереди уменьшается. Для этого посмотрите статистику очереди:
- В консоли управления откройте сервис Message Queue.
- Выберите очередь, для которой создали триггер.
- Перейдите в раздел Мониторинг. Посмотрите график Сообщений в очереди.