This allows you to configure alert rules managed by the data source of your choice, instead of using Grafana’s managed alert rules.
How to add alerts to a function
This page shows you how to configure alerts for Scaleway Serverless Functions using Scaleway Cockpit and Grafana.
Before you startLink to this anchor
To complete the actions presented below, you must have:
- A Scaleway account logged into the console
- Owner status or IAM permissions allowing you to perform actions in the intended Organization
- Scaleway resources you can monitor
- Created Grafana credentials with the Editor role
- Enabled the alert manager
- Created at least one contact point
- Selected the Scaleway Alerting alert manager in Grafana
-
Log in to Grafana using your credentials.
-
Click the Toggle menu then click Alerting.
-
Click Alert rules and + New alert rule.
-
Scroll down to the Define query and alert condition section and click Switch to data source-managed alert rule.
Important -
Type in a name for your alert.
-
Select the data source you want to configure alerts for. For the sake of this documentation, we are choosing the Scaleway Metrics data source.
-
In the Metrics browser drop-down, select the metric you want to configure an alert for. Refer to the table below for details on each alert for Serverless Functions.
AnyFunctionError
- Pending period
- 10s
- Summary
- Function
{{ $labels.resource_name }}
is in error. - Query and alert condition
serverless_function_status{status="error"} == 1
- Description
- Function
{{ $labels.resource_name }}
with ID{{ $labels.resource_id }}
is in error. Check the console to find out the error message.
FunctionError
- Pending period
- 10s
- Summary
- Function
{{ $labels.resource_name }}
is in error. - Query and alert condition
serverless_function_status{status="error",resource_id="your-function-id-here"} == 1
- Description
- Function
{{ $labels.resource_name }}
with ID{{ $labels.resource_id }}
is in error. Check the console to find out the error message.
AnyFunctionHighCPUUsage
- Pending period
- 10m
- Summary
- High CPU usage for function
{{ $labels.resource_name }}
. - Query and alert condition
serverless_function_cpu_usage_ratio > 90
- Description
- Function
{{ $labels.resource_name }}
with ID{{ $labels.resource_id }}
is using more than{{ printf "%.0f" $value }}
% of its available CPU since 10m.
FunctionHighCPUUsage
- Pending period
- 10m
- Summary
- High CPU usage for function
{{ $labels.resource_name }}
. - Query and alert condition
serverless_function_cpu_usage_ratio{resource_id="your-function-id-here"} > 90
- Description
- Function
{{ $labels.resource_name }}
with ID{{ $labels.resource_id }}
is using more than{{ printf "%.0f" $value }}
% of its available CPU since 10m.
AnyFunctionHighMemoryUsage
- Pending period
- 10m
- Summary
- High memory usage for function
{{ $labels.resource_name }}
. - Query and alert condition
(serverless_function_memory_usage_bytes / serverless_function_memory_limit_bytes) * 100 > 90
- Description
- Function
{{ $labels.resource_name }}
with ID{{ $labels.resource_id }}
is using more than{{ printf "%.0f" $value }}
% of its available RAM since 10m.
FunctionHighMemoryUsage
- Pending period
- 10m
- Summary
- High memory usage for function
{{ $labels.resource_name }}
. - Query and alert condition
(serverless_function_memory_usage_bytes{resource_id="your-container-id-here"} / serverless_function_memory_limit_bytes{resource_id="your-container-id-here"}) * 100 > 90
- Description
- Function
{{ $labels.resource_name }}
with ID{{ $labels.resource_id }}
is using more than{{ printf "%.0f" $value }}
% of its available RAM since 10m.
-
Select labels that apply to the metric you have selected in the previous step, to target your desired resources and fine-tune your alert.
-
Select one or more values for your labels.
-
Click Use query to generate your alert based on the conditions you have defined.
-
Select a folder to store your rule, or create a new one. Folders allow you to easily manage your different rules.
-
Select an evaluation group to add your rule to. Rules within the same group are evaluated sequentially over the same time interval.
-
In the Set alert evaluation behavior field, configure the amount of time during which the alert can be in breach of the condition(s) you have defined until it triggers.
NoteFor example, if you wish to be alerted after your alert has been in breach of the condition for 2 minutes without interruption, type
2
and selectminutes
in the drop-down. -
Optionally, add a summary and a description.
-
Click Save rule at the top right corner of your screen to save your alert. Once your alert meets the requirements you have configured, you will receive an email to inform you that your alert has been triggered.