Creating a trigger for Cloud Logging that sends messages to WebSocket connections

If you do not have the Yandex Cloud CLI yet, install and initialize it.

The folder used by default is the one specified when creating the CLI profile. To change the default folder, use the yc config set folder-id <folder_ID> command. You can also specify a different folder for any command using --folder-name or --folder-id. If you access a resource by its name, the search will be limited to the default folder. If you access a resource by its ID, the search will be global, i.e., through all folders based on access permissions.

To create a trigger that sends messages to WebSocket connections, run this command:

yc serverless trigger create logging \
  --name <trigger_name> \
  --log-group-name <log_group_name> \
  --batch-size 1 \
  --batch-cutoff 1s \
  --resource-ids <resource_ID> \
  --resource-types <resource_type> \
  --stream-names <logging_stream> \
  --log-levels <logging_level> \
  --gateway-id <API_gateway_ID> \
  --gateway-websocket-broadcast-path <path> \
  --gateway-websocket-broadcast-service-account-id <service_account_ID>

Where:

• --name: Trigger name.
• --log-group-name: Name of the log group that will invoke a container when entries are added to it.

• --batch-size: Message batch size. This is an optional parameter. The values may range from 1 to 10. The default value is 1.
• --batch-cutoff: Maximum wait time. This is an optional parameter. The values may range from 0 to 20 seconds. The default value is 10 seconds. The trigger groups messages for a period not exceeding batch-cutoff and sends them to WebSocket connections. The number of messages cannot exceed batch-size.

• --resource-ids: IDs of your resources or Yandex Cloud resources, e.g., functions in Cloud Functions. This is an optional setting.
• --resource-types: Types of resources, e.g., serverless.function in Cloud Functions. This is an optional setting.
• --stream-names: Log streams. This is an optional setting.
• --log-levels: Logging levels. This is an optional setting.
  A trigger fires when the specified log group receives entries that comply with all of the following settings: resource-ids, resource-types, stream-names, and log-levels. If the setting is not specified, the trigger fires for any value.

• --gateway-id: API gateway ID.
• --gateway-websocket-broadcast-path: Path in the OpenAPI specification. Messages will be sent through WebSocket connections established using this path.
• --gateway-websocket-broadcast-account-id: Service account ID with permissions to send messages to WebSocket connections.

Result:

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

To create a trigger for Cloud Logging, use the create REST API method for the Trigger resource or the TriggerService/Create gRPC API call.