Создать триггер для Cloud Logging, который отправляет сообщения в WebSocket-соединения
Создайте триггер для Cloud Logging, который будет отправлять сообщения в WebSocket-соединения при добавлении записей в лог-группу.
Перед началом работы
Для создания триггера вам понадобятся:
-
API-шлюз. Сообщения будут отправляться в WebSocket-соединения, подключенные к API-шлюзу. Если у вас нет API-шлюза, создайте его.
-
Сервисный аккаунт с ролью
api-gateway.websocketBroadcaster
. Если у вас нет сервисного аккаунта, создайте его.
- Лог-группа, при добавлении записей в которую триггер будет запускаться. Если у вас нет лог-группы, создайте ее.
Создать триггер
Примечание
Триггер начинает работать в течение 5 минут после создания.
-
В консоли управления
перейдите в каталог, в котором хотите создать триггер. -
Откройте сервис API Gateway.
-
На панели слева выберите
Триггеры. -
Нажмите кнопку Создать триггер.
-
В блоке Базовые параметры:
- Введите имя и описание триггера.
- В поле Тип выберите
Cloud Logging
. - В поле Запускаемый ресурс выберите
API-шлюз
.
-
В блоке Настройки Cloud Logging укажите:
- Лог-группу.
- (Опционально) Типы ресурсов, например функции Cloud Functions
serverless.function
. - (Опционально) Идентификаторы ваших ресурсов или ресурсов Yandex Cloud, например функций Cloud Functions.
- (Опционально) Потоки логирования.
- (Опционально) Уровни логирования.
Триггер срабатывает, когда в указанную лог-группу добавляют записи, которые соответствуют всем опциональным настройкам. Если опциональная настройка не задана, триггер срабатывает при любом ее значении.
-
В блоке Настройки группирования сообщений укажите:
- размер группы сообщений. Допустимые значения от 1 до 1000, значение по умолчанию — 1.
- максимальное время ожидания. Допустимые значения от 1 до 60 секунд, значение по умолчанию — 1 секунда.
Триггер группирует сообщения не дольше указанного времени ожидания и отправляет их в WebSocket-соединения. Число сообщений при этом не превышает указанный размер группы.
-
В блоке Настройки API-шлюза:
- В поле API-шлюз выберите API-шлюз.
- В поле Путь укажите путь в OpenAPI-спецификации. Через WebSocket-соединения, которые установлены по этому пути, будут отправляться сообщения.
- В поле Сервисный аккаунт выберите сервисный аккаунт, от имени которого в WebSocket-соединения будут отправляться сообщения.
-
Нажмите кнопку Создать триггер.
Если у вас еще нет интерфейса командной строки Yandex Cloud, установите и инициализируйте его.
По умолчанию используется каталог, указанный в профиле CLI. Вы можете указать другой каталог с помощью параметра --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 Functionsserverless.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-шлюза, в них отображается информация об обращениях к нему.