Creating a trigger for budgets that invokes a Cloud Functions function
Create a trigger for budgets that calls a Cloud Functions function when threshold values are exceeded.
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 permissions 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 budget which, when exceeded, fires a trigger. If you do not have a budget, 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 a trigger.
-
Select Cloud Functions.
-
In the left-hand panel, select Triggers.
-
Click Create trigger.
-
Under Basic settings:
- Enter a name and description for the trigger.
- In the Type field, select Budget.
- In the Launched resource field, select Function.
-
Under Budget settings, select your billing account and budget. You can select Any budget.
-
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.
-
Optionally, under Dead Letter Queue settings, select the dead-letter queue and the service account with write permissions 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 billing-budget \
--name <trigger_ID> \
--billing-account-id <billing_account_ID> \
--budget-id <budget_ID> \
--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.--billing-account-id: Billing account ID.--budget-id: Budget ID.
--invoke-function-id: Function ID.--invoke-function-service-account-id: ID of the service account with permissions to invoke the function.--retry-attempts: Number of invocation retries before the trigger moves a message to the dead-letter queue. This is an 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. This is an optional parameter. The values may range from 10 to 60 seconds. The default value is 10 seconds.--dlq-queue-id: Dead-letter queue ID. This is an optional parameter.--dlq-service-account-id: ID of the service account with write permissions to the dead-letter queue. This is an optional parameter.
Result:
id: a1sfe084v4**********
folder_id: b1g88tflru**********
created_at: "2019-12-04T08:45:31.131391Z"
name: budget-trigger
rule:
billing-budget:
billing-account-id: dn2char50j**********
budget-id: dn2jnshmdlc1********
invoke_function:
function_id: d4eofc7n0m03********
function_tag: $latest
service_account_id: aje3932acd0c********
retry_settings:
retry_attempts: "1"
interval: 10s
dead_letter_queue:
queue-id: yrn:yc:ymq:ru-central1:aoek49ghmknn********:dlq
service-account-id: aje3932acd0c********
status: ACTIVE
To create a trigger for budgets, 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.