Creating a trigger for Cloud Logging that invokes a Cloud Functions function
Create a trigger for Cloud Logging that calls a Cloud Functions function when entries are added to a log group.
Getting started
To create a trigger, you need:
-
A function that the trigger will invoke. If you do not have a function:
-
(Optional) A Dead Letter Queue where messages that could not be processed by a function will be redirected. If you do not have a queue, create one.
-
Service accounts with rights to invoke the function and (optionally) write messages to the Dead Letter Queue. You can use the same service account or different ones. If you do not have a service account, create one.
- A log group that activates the trigger when entries are added there. If you do not have a log group, create one.
Creating a trigger
Note
The trigger is initiated within 5 minutes of being created.
-
In the management console
, select the folder where you want to create your trigger. -
Select Cloud Functions.
-
In the left-hand panel, select
-
Click Create trigger.
-
Under Basic settings:
- Enter a name and description for the trigger.
- In the Type field, select
Cloud Logging
. - In the Launched resource field, select
Function
.
-
Under Cloud Logging settings, specify:
- Log group.
- (Optional) Resource types, such as
serverless.function
for Cloud Functions functions. - (Optional) IDs of Yandex Cloud or your resources, such as Cloud Functions functions.
- (Optional) Log streams.
- (Optional) Logging levels.
A trigger fires when records that match all the optional settings are added to the specified log group. If an optional setting is not specified, the trigger fires for any value of the setting.
-
(Optional) Under Batch message settings, specify:
- Waiting time, s. The values may range from 1 to 60 seconds. The default value is 1 second.
- Batch size. The values may range from 1 to 100. The default value is 1.
The trigger groups messages for a period of time not exceeding the specified timeout and sends them to a function. However, the number of messages does not exceed the specified group size.
-
Under Function settings, select a function and specify:
- Function version tag.
- Service account to invoke the function under.
-
(Optional) Under Repeat request settings:
- In the Interval field, specify the time after which the function will be invoked again if the current attempt fails. The values may range from 10 to 60 seconds. The default value is 10 seconds.
- In the Number of attempts field, specify the number of invocation retries before the trigger moves a message to the Dead Letter Queue. The values may range from 1 to 5. The default value is 1.
-
(Optional) Under Dead Letter Queue settings, select the dead letter queue and the service account with write privileges for this queue.
-
Click Create trigger.
If you do not 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 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> \
--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
: Name of the log group that will invoke the function when records 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 1 to 60 seconds. The default value is 1 second. The trigger groups messages for a period not exceedingbatch-cutoff
and sends them to a function. The number of messages cannot exceedbatch-size
.
--resource-ids
: IDs of Yandex Cloud or your resources, such as Cloud Functions functions. This is an optional parameter.--resource-types
: Resource types, such asserverless.function
for Cloud Functions functions. This is an optional parameter.--stream-names
: Log streams. This is an optional parameter.--log-levels
: Logging levels. This is an optional parameter.
The trigger fires when the specified log group receives records that match all of the following parameters:resource-ids
,resource-types
,stream-names
, andlog-levels
. If a parameter is not specified, the trigger fires for any value of the parameter.
--invoke-function-id
: Function ID.--invoke-function-service-account-id
: Service account with rights to invoke the function.--retry-attempts
: Number of invocation retries before the trigger moves a message to the Dead Letter Queue. Optional parameter. The values may range from 1 to 5. The default value is 1.--retry-interval
: Time after which the function will be invoked again if the current attempt fails. Optional parameter. The values may range from 10 to 60 seconds. The default value is 10 seconds.--dlq-queue-id
: Dead Letter Queue ID. Optional parameter.--dlq-service-account-id
: Service account with the permission to write messages to the Dead Letter Queue. Optional parameter.
Result:
id: a1sfe084v4**********
folder_id: b1g88tflru**********
created_at: "2019-12-04T08:45:31.131391Z"
name: logging-trigger
rule:
logging:
log-group-name: default
resource_type:
- serverless.functions
resource_id:
- d4e1gpsgam78********
stream_name:
- test
levels:
- INFO
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
Terraform
For more information about the provider resources, see the documentation on the Terraform
If you change the configuration files, Terraform automatically detects 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:
-
In the configuration file, describe the trigger parameters.
Here is an example of the configuration file structure:
resource "yandex_function_trigger" "my_trigger" { name = "<trigger_name>" description = "<trigger_description>" logging { group_id = "<log_group_name>" resource_types = [ "<resource_type>" ] resource_ids = [ "<resource_ID>" ] levels = [ "INFO", "ERROR" ] stream_names = [ "<logging_stream>" ] batch_cutoff = 1 batch_size = 1 } function { id = "<function_ID>" service_account_id = "<service_account_ID>" } }
Where:
-
name
: Trigger name. The name format is as follows:- The name must be from 3 to 63 characters long.
- It may contain lowercase Latin letters, numbers, and hyphens.
- The first character must be a letter and the last character cannot 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, e.g.,resource_types = [ "serverless.function" ]
for Cloud Functions functions. You can specify multiple types.resource_ids
: IDs of your resources or Yandex Cloud resources, e.g.,resource_ids = [ "<function_ID>" ]
functions. You can specify multiple IDs.levels
: Logging levels. For example,levels = [ "INFO", "ERROR"]
.stream_names
: Log streams.
A trigger fires when the specified log group receives records that match all of the following parameters:resource-ids
,resource-types
,stream-names
, andlevels
. If a parameter is not specified, the trigger fires for any value of the parameter.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 specifiedbatch-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
. -
-
Make sure the configuration files are correct.
-
In the command line, go to the directory where you created the configuration file.
-
Run a check using this command:
terraform plan
If the configuration is described correctly, the terminal will display a list of created resources and their parameters. If the configuration contains any errors, Terraform will point them out.
-
-
Deploy cloud resources.
-
If the configuration does not contain any errors, run this command:
terraform apply
-
Confirm creating the resources: type
yes
in the terminal and press Enter.All the resources you need will then be created in the specified folder. You can check the new resources and their configuration using the management console
or this CLI command:yc serverless trigger get <trigger_ID>
-
To create a trigger for Cloud Logging, use the create REST API method for the Trigger resource or the TriggerService/Create gRPC API call.
Checking the result
Check that the trigger operates correctly. Do it by viewing function logs that present information on invocations.