Creating a trigger for Cloud Logging that invokes a Cloud Functions function

If you don't have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To create a trigger that invokes a function, run the command:

yc serverless trigger create logging \
  --name <trigger name> \
  --log-group-name <log group name> \
  --batch-size 1 \
  --batch-cutoff 1s \
  --invoke-function-id <function ID> \
  --invoke-function-service-account-id <service account ID> \
  --retry-attempts 1 \
  --retry-interval 10s \
  --dlq-queue-id <Dead Letter Queue ID> \
  --dlq-service-account-id <service account ID>

Where:

• --name: Trigger name.
• --log-group-name: The name of the log group that will cause the function to be called when records are added.
• --batch-size: Message batch size. Optional. Valid values range from 1 to 100. The default is 1.
• --batch-cutoff: Maximum waiting time. Optional. Valid values range from 0 to 60 seconds. The default is 1 second. The trigger groups messages for a period not exceeding batch-cutoff and sends them to a function. At the same time, the number of messages does not exceed batch-size.

• --invoke-function-id: Function ID.
• --invoke-function-service-account-id: Service account with rights to invoke the function.
• --retry-attempts: The time after which the function will be invoked again if the current attempt fails. Optional. Values can be from 10 to 60 seconds. The default is 10 seconds.
• --retry-interval: The number of invocation retries before the trigger moves a message to the Dead Letter Queue. Optional. Values can be from 1 to 5. The default is 1.
• --dlq-queue-id: Dead Letter Queue ID. Optional.
• --dlq-service-account-id: Service account with rights to write messages to the Dead Letter Queue. Optional.

Result:

id: a1sfe084v4**********
folder_id: b1g88tflru**********
created_at: "2019-12-04T08:45:31.131391Z"
name: logging-trigger
rule:
  logging:
    log-group-name: default
    batch_settings:
      size: "1"
      cutoff: 1s
    invoke_function:
      function_id: d4eofc7n0m**********
      function_tag: $latest
      service_account_id: aje3932acd**********
      retry_settings:
        retry_attempts: "1"
        interval: 10s
      dead_letter_queue:
        queue-id: yrn:yc:ymq:ru-central1:aoek49ghmk**********:dlq
        service-account-id: aje3932a**********
status: ACTIVE

You can create a trigger for Cloud Logging using the create.

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it by configuration files. They store the infrastructure description in HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Mozilla Public License.

For more information about the provider resources, see the documentation on the Terraform site or mirror site.

If you change the configuration files, Terraform automatically determines which part of your configuration is already deployed and what should be added or removed.

If you don't have Terraform, install it and configure the Yandex Cloud provider.

To create a trigger for Cloud Logging:

1. In the configuration file, describe the trigger parameters.

   Example configuration file structure:

   resource "yandex_function_trigger" "my_trigger" {
     name        = "<trigger name>"
     description = "<trigger description>"
     logging {
        group_id       = "<log group ID>"
        resource_types = [ "<resource type>" ]
        resource_ids   = [ "<resource ID>" ]
        levels         = [ "INFO", "ERROR" ]
        batch_cutoff   = 1
        batch_size     = 1
     function {
        id                 = "<function ID>"
        service_account_id = "<service account ID>"
     }
   }
   

   Where:

   • name: Trigger name. Name format:

     • The length can be from 3 to 63 characters.
     • It may contain lowercase Latin letters, numbers, and hyphens.
     • The first character must be a letter. The last character can't be a hyphen.

   • description: Trigger description.

   • logging: Logging parameters, which will activate the trigger when added to the log group, and the batch message settings:

     • group_id: Log group ID.
     • resource_types: Resource types: your services or Yandex Cloud services, for example, resource_types = [ "serverless.function" ]. You can specify more than one service at a time.
     • resource_ids: IDs of your resources or Yandex Cloud resources, for example, functions resource_ids = [ "<function ID>" ]. You can specify multiple IDs.
     • levels: Logging levels. For example, levels = [ "INFO", "ERROR"].
     • batch_cutoff: Maximum wait time. Acceptable values are from 0 to 60 seconds. The trigger groups messages for a period of time not exceeding the specified timeout and sends them to a function or container. At the same time, the number of messages does not exceed the specified batch-size group.
     • batch_size: Message batch size. Acceptable values are from 1 to 100.

   • function: Settings for the function, which will be activated by the trigger:

     • id: Function ID.
     • service_account_id: ID of the service account with rights to invoke a function.

   For more information about resource parameters in Terraform, see the provider documentation.

2. Make sure that the configuration files are valid.

   1. In the command line, go to the directory where you created the configuration file.

   2. Run the check using the command:

      terraform plan
      

   If the configuration is described correctly, the terminal displays a list of created resources and their parameters. If the configuration contains errors, Terraform will point them out.

3. Deploy the cloud resources.

   1. If the configuration doesn't contain any errors, run the command:

      terraform apply
      

   2. Confirm the resource creation: type yes in the terminal and press Enter.

      Afterwards, all the necessary resources are created in the specified folder. You can verify that the resources are there and properly configured in the management console or using the following CLI command:

      yc serverless trigger get <trigger ID>