Yandex Cloud
Поиск
Связаться с намиПодключиться
  • Документация
  • Блог
  • Все сервисы
  • Статус работы сервисов
    • Популярные
    • Инфраструктура и сеть
    • Платформа данных
    • Контейнеры
    • Инструменты разработчика
    • Бессерверные вычисления
    • Безопасность
    • Мониторинг и управление ресурсами
    • Машинное обучение
    • Бизнес-инструменты
  • Все решения
    • По отраслям
    • По типу задач
    • Экономика платформы
    • Безопасность
    • Техническая поддержка
    • Каталог партнёров
    • Обучение и сертификация
    • Облако для стартапов
    • Облако для крупного бизнеса
    • Центр технологий для общества
    • Облако для интеграторов
    • Поддержка IT-бизнеса
    • Облако для фрилансеров
    • Обучение и сертификация
    • Блог
    • Документация
    • Контент-программа
    • Мероприятия и вебинары
    • Контакты, чаты и сообщества
    • Идеи
    • Истории успеха
    • Тарифы Yandex Cloud
    • Промоакции и free tier
    • Правила тарификации
  • Документация
  • Блог
Проект Яндекса
© 2025 ООО «Яндекс.Облако»
Yandex API Gateway
  • Начало работы
    • Все инструкции
    • Создание API-шлюза
      • Создать таймер
      • Создать триггер для Message Queue
      • Создать триггер для Object Storage
      • Создать триггер для Container Registry
      • Создать триггер для Cloud Logging
      • Создать триггер для бюджетов
      • Создать триггер для Data Streams
      • Создать триггер для почты
    • Просмотр операций с ресурсами сервиса
  • Управление доступом
  • Правила тарификации
  • Справочник Terraform
  • Метрики Monitoring
  • Аудитные логи Audit Trails
  • История изменений
  • Вопросы и ответы
  • Обучающие курсы

В этой статье:

  • Перед началом работы
  • Создать триггер
  • Проверить результат
  • См. также
  1. Пошаговые инструкции
  2. Создание триггера
  3. Создать триггер для Cloud Logging

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

Статья создана
Yandex Cloud
Улучшена
mmerihsesh
Обновлена 21 апреля 2025 г.
  • Перед началом работы
  • Создать триггер
  • Проверить результат
  • См. также

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

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

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

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

    Примечание

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

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

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

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

Примечание

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

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

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

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

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

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

    • Введите имя и описание триггера.
    • В поле Тип выберите Cloud Logging.
    • В поле Запускаемый ресурс выберите API-шлюз.
  6. В блоке Настройки Cloud Logging укажите:

    • Лог-группу.
    • (Опционально) Типы ресурсов, например функции Cloud Functions serverless.function.
    • (Опционально) Идентификаторы ваших ресурсов или ресурсов Yandex Cloud, например функций Cloud Functions.
    • (Опционально) Потоки логирования.
    • (Опционально) Уровни логирования.

    Триггер срабатывает, когда в указанную лог-группу добавляют записи, которые соответствуют всем опциональным настройкам. Если опциональная настройка не задана, триггер срабатывает при любом ее значении.

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

    • размер группы сообщений. Допустимые значения от 1 до 1000, значение по умолчанию — 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 logging \
  --name <имя_триггера> \
  --log-group-name <имя_лог-группы> \
  --batch-size 1 \
  --batch-cutoff 1s \
  --resource-ids <идентификатор_ресурса> \
  --resource-types <тип_ресурса> \
  --stream-names <поток_логирования> \
  --log-levels <уровень_логирования> \
  --gateway-id <идентификатор_API-шлюза> \
  --gateway-websocket-broadcast-path <путь> \
  --gateway-websocket-broadcast-service-account-id <идентификатор_сервисного_аккаунта>

Где:

  • --name — имя триггера.
  • --log-group-name — имя лог-группы, при добавлении записей в которую будет вызываться контейнер.
  • --batch-size — размер группы сообщений. Необязательный параметр. Допустимые значения от 1 до 10, значение по умолчанию — 1.
  • --batch-cutoff — максимальное время ожидания. Необязательный параметр. Допустимые значения от 0 до 20 секунд, значение по умолчанию — 10 секунд. Триггер группирует сообщения не дольше batch-cutoff и отправляет их в WebSocket-соединения. Число сообщений при этом не превышает 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. Если параметр не задан, триггер срабатывает при любом его значении.
  • --gateway-id — идентификатор API-шлюза.
  • --gateway-websocket-broadcast-path — путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
  • --gateway-websocket-broadcast-account-id — идентификатор сервисного аккаунта с правами на отправку сообщений в WebSocket-соединения.

Результат:

id: a1s5msktijh2********
folder_id: b1gmit33hgh2********
created_at: "2023-08-04T15:19:15.353909857Z"
name: logging-trigger
rule:
  logging:
    log_group_id: e23bidnftlh2********
    resource_type:
      - serverless.functions
    resource_id:
      - d4e1gpsgam78********
    stream_name:
      - test
    levels:
      - INFO
    batch_settings:
      size: "1"
      cutoff: 1s
    gateway_websocket_broadcast:
      gateway_id: d4eofc7n0mh2********
      path: /
      service_account_id: aje3932acdh2********
status: ACTIVE

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

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

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

См. также

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

Была ли статья полезна?

Предыдущая
Создать триггер для Container Registry
Следующая
Устройство
Проект Яндекса
© 2025 ООО «Яндекс.Облако»