Связаться с намиПодключиться

Создать триггер для Data Streams, который отправляет сообщения в WebSocket-соединения

Статья создана
Улучшена
Обновлена 21 апреля 2025 г.

Создайте триггер для Data Streams, который будет отправлять сообщения в WebSocket-соединения при отправке данных в поток.

Примечание

Триггер для Data Streams принимает и отправляет сообщения только в формате JSON.

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

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

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

    Примечание

    Триггер не вызывает API-шлюз при отправке сообщений в WebSocket-соединения.

  • Сервисный аккаунт с ролью api-gateway.websocketBroadcaster. Если у вас нет сервисного аккаунта, создайте его.

  • Поток, при отправке данных в который триггер будет запускаться. Если у вас нет потока, создайте его.

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

Примечание

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

  1. В консоли управления перейдите в каталог, в котором хотите создать триггер.

  2. Откройте сервис API Gateway.

  3. На панели слева выберите Триггеры.

  4. Нажмите кнопку Создать триггер.

  5. В блоке Базовые параметры:

    • Введите имя и описание триггера.
    • В поле Тип выберите Data Streams.
    • В поле Запускаемый ресурс выберите API-шлюз.

  6. В блоке Настройки Data Streams выберите поток данных и сервисный аккаунт с правами на чтение из потока данных и запись в него.

  7. (Опционально) В блоке Настройки группирования сообщений укажите:

    • размер группы сообщений в байтах. Допустимые значения от 1 Б до 64 КБ, значение по умолчанию — 1 Б.
    • максимальное время ожидания. Допустимые значения от 1 до 60 секунд, значение по умолчанию — 1 секунда.

    Триггер группирует сообщения не дольше указанного времени ожидания и отправляет их в WebSocket-соединения. Суммарный объем данных, которые передаются в соединения, может превышать указанный размер группы, если данные передаются в одном сообщении. Во всех остальных случаях объем данных не превышает размер группы.

  8. В блоке Настройки API-шлюза:

    • В поле API-шлюз выберите API-шлюз.
    • В поле Путь укажите путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
    • В поле Сервисный аккаунт выберите сервисный аккаунт, от имени которого в WebSocket-соединения будут отправляться сообщения.

  9. Нажмите кнопку Создать триггер.

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

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

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

yc serverless trigger create yds \
  --name <имя_триггера> \
  --database <размещение_базы_данных> \
  --stream <имя_потока_данных> \
  --batch-size 1b \
  --batch-cutoff 1s \
  --stream-service-account-id <идентификатор_сервисного_аккаунта> \
  --gateway-id <идентификатор_API-шлюза> \
  --gateway-websocket-broadcast-path <путь> \
  --gateway-websocket-broadcast-service-account-id <идентификатор_сервисного_аккаунта>

Где:

  • --name — имя триггера.

  • --database — размещение базы данных YDB, к которой привязан поток Data Streams.

    Чтобы узнать, где размещена база данных, выполните команду yc ydb database list. Размещение базы данных указано в столбце ENDPOINT, в параметре database, например /ru-central1/b1gia87mbah2********/etn7hehf6gh3********.

  • --stream — имя потока данных.

  • --batch-size — размер группы сообщений. Необязательный параметр. Допустимые значения от 1 Б до 64 КБ, значение по умолчанию — 1 Б.

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

  • --stream-service-account-id — идентификатор сервисного аккаунта, у которого есть права на чтение из потока данных и запись в него.

  • --gateway-id — идентификатор API-шлюза.
  • --gateway-websocket-broadcast-path — путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
  • --gateway-websocket-broadcast-account-id — идентификатор сервисного аккаунта с правами на отправку сообщений в WebSocket-соединения.

Результат:

id: a1s5msktijh2********
folder_id: b1gmit33hgh2********
created_at: "2022-10-24T14:07:04.693126923Z"
name: data-streams-trigger
rule:
  data_stream:
    database: /ru-central1/b1gia87mbah2********/etn7hehh2********
    stream: streams-name
    service_account_id: ajep8qm0kh2********
    batch_settings:
      size: "1"
      cutoff: 1s
    gateway_websocket_broadcast:
      gateway_id: d4eofc7n0mh2********
      path: /
      service_account_id: aje3932acdh2********
status: ACTIVE

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

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

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

См. также

Предыдущая
Создать триггер для бюджетов
Следующая
Создать триггер для почты