Creating a trigger for budgets that sends messages to WebSocket connections
Create a trigger for budgets to send messages to WebSocket connections when threshold values are exceeded.
Getting started
To create a trigger, you will need:
-
API gateway. Messages will be sent to WebSocket connections accessing the API gateway at the path specified in the trigger settings. If you do not have an API gateway, create one.
Note
The trigger does not call the API gateway when sending messages to WebSocket connections.
-
Service account with the
api-gateway.websocketBroadcasterrole. If you do not have a service account, create one.
- Budget for which a trigger will fire in case it is exceeded. If you do not have a budget, create one.
Creating a trigger
Note
The trigger is initiated within five minutes after it is created.
-
In the management console, select the folder where you want to create a trigger.
-
Go to API Gateway.
-
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
API gateway.
-
Under Budget settings, select your billing account and budget. You can select Any budget.
-
Under API gateway settings:
- In the API gateway field, select the API gateway.
- In the Path field, specify the path in the OpenAPI specification. Messages will be sent through WebSocket connections established using this path.
- In the Service account field, select the service account to send messages to WebSocket connections.
-
Click Create trigger.
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 billing-budget \
--name <trigger_name> \
--billing-account-id <billing_account_ID> \
--budget-id <budget_ID> \
--gateway-id <API_gateway_ID> \
--gateway-websocket-broadcast-path <path> \
--gateway-websocket-broadcast-service-account-id <service_account_ID>
Where:
--name: Trigger name.--billing-account-id: Billing account ID.--budget-id: Budget ID.
--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: a1sfe084v4h2********
folder_id: b1g88tflruh2********
created_at: "2019-12-04T08:45:31.131391Z"
name: budget-trigger
rule:
billing-budget:
billing-account-id: dn2char50jh2********
budget-id: dn2jnshmdlh2********
gateway_websocket_broadcast:
gateway_id: d4eofc7n0mh2********
path: /
service_account_id: aje3932acdh2********
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 the API gateway logs that present information about its incoming requests.