Prometheus parameters
In this article:
Prometheus parameters#
Parameters for creating and modifying a notification channel#
These parameters are specified as parameters in the CreateNotificationChannel and ModifyNotificationChannel methods
When creating a new notification channel, be sure to specify all parameters marked as Necessary. When modifying an existing notification channel, be sure to pass all parameters that can be edited. If a parameter is not passed, its value will be cleared. Parameters that cannot be edited are not required to be passed, but their values must match the current values if passed.
type#
Channel type.
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
Yes |
No |
String |
email |
is_default#
Specifies whether to use the notification channel as the default one.
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
No |
Yes |
Boolean |
true |
send_resolved#
Specifies whether to notify of resolved problems.
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
No |
Yes |
Boolean |
true |
bot_token#
Role for anonymous access.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
Yes |
Yes |
String |
Telegram |
Correct Telegram token |
chat_id#
Telegram chat ID.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
Yes |
Yes |
Integer |
Telegram |
Valid Telegram chat ID |
url#
URL to which the request is routed when an alert is triggered.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
Yes |
Yes |
String |
webhook |
Valid URL |
max_alerts#
Maximum number of alerts per message. Alerts beyond this number will be lost.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
No |
Yes |
Integer |
webhook |
Positive number |
to#
E-mail address.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
Yes |
Yes |
String |
Valid e-mail address |
from#
E-mail address that will be specified as a sender.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
No |
Yes |
String |
Valid e-mail address |
smarthost#
Address of the SMTP server via which e-mails will be sent.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
Yes |
Yes |
String |
A valid SMTP server address with mandatory indication of the port |
hello#
Host name used for identification on the SMTP server.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
No |
Yes |
String |
Valid host name or IP address |
require_tls#
Use an encrypted connection to the SMTP server.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
Yes, if auth_username and auth_password are specified |
Yes |
Boolean |
true |
auth_username#
User name used for authentication on the SMTP server.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
No |
Yes |
String |
String of 256 characters max |
auth_password#
User password used for authentication on the SMTP server.
Required |
Editable |
Datatype |
Channel type |
Valid values |
---|---|---|---|---|
No |
Yes |
String |
String of 256 characters max |
monitoring - The monitoring information for the instance#
Connection to a monitoring service.
Required |
Editable |
Datatype |
Valid values |
Default |
---|---|---|---|---|
For all services, except for Prometheus |
Yes |
Boolean |
true |
false |
monitor_by#
Monitoring service ID. The specified service must be deployed in the same project as the current service.
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
Yes, if the |
Yes |
String |
The ID of a monitoring service running within the same VPC as the current service |
monitoring_labels#
Labels to be assigned to the metrics of the monitored service in the monitoring service.
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
No. If |
Yes |
Dict |
The label name may contain digits, Latin letters, and an underscore character. The label value may contain any ASCII characters. |
options#
Container for other parameters ELK.
Note
If the parameter name includes a dot, then it cannot be passed in the container for additional parameters. If you need to use such parameter, contact technical support.
Required |
Datatype |
Valid values |
---|---|---|
No |
Dict |
N/A |
Parameters for creating and modifying a route#
These parameters are specified as parameters in the CreatePrometheusRoute and ModifyPrometheusRoute methods
When creating a new notification channel, be sure to specify all parameters marked as Necessary. When modifying an existing notification channel, be sure to pass all parameters that can be edited. If a parameter is not passed, its value will be cleared. Parameters that cannot be edited are not required to be passed, but their values must match the current values if passed.
matchers#
Criteria used to select the notification recipient. The matchers filter may contain one or more conditions that determine whether an alert will be sent to this recipient. A condition consists of a label name, operator, and value. Supported operators: =, !=, =~, !~. If there are several conditions, the “logical AND” operation is used.
Examples of matchers:
alertname = "Node down"
severity =~ "warning|critical"
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
Yes |
Yes |
List of strings |
Valid criterion for selecting a Prometheus route |
receiver#
Notification recipient.
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
Yes |
Yes |
String |
It must be the name of one of notification channels of the particular service |
continue#
Specifies whether to continue iterating through the route selection criteria after the first match is found.
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
Yes |
Yes |
Boolean |
true |
group_by#
List of labels by which alerts will be grouped to send notifications.
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
No |
Yes |
Array of strings |
List of correct Prometheus labels |
group_wait#
Time to wait before sending the first notification about an alert group. Specified in Time duration format
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
No |
Yes |
String |
String in Time duration format. Valid ranges: 1-30d, 1-24h, 1-60m, 1-60s, 1-99999ms. Combining is available, for example 30d24h60m60s99999ms. |
group_interval#
Time to wait before sending a notification after adding an alert to a group for which a notification has already been sent. Specified in Time duration format
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
No |
Yes |
String |
String in Time duration format. Valid ranges: 1-30d, 1-24h, 1-60m, 1-60s, 1-99999ms. Combining is available, for example 30d24h60m60s99999ms. |
repeat_interval#
Time to wait before sending the second notification about an alert group. Specified in Time duration format
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
No |
Yes |
String |
String in Time duration format. Valid ranges: 1-30d, 1-24h, 1-60m, 1-60s, 1-99999ms. Combining is available, for example 30d24h60m60s99999ms. |
Parameters for creating and modifying a scrape job#
These parameters are specified as parameters in the CreatePrometheusScrapeJob and ModifyPrometheusScrapeJob methods
When creating a new notification channel, be sure to specify all parameters marked as Necessary. When modifying an existing notification channel, be sure to pass all parameters that can be edited. If a parameter is not passed, its value will be cleared. Parameters that cannot be edited are not required to be passed, but their values must match the current values if passed.
targets#
List of addresses of third-party services to connect to monitoring.
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
Yes |
Yes |
Array of strings |
List of valid addresses |
labels#
Labels to be assigned to the received metrics. The label names may contain digits, Latin letters, and underscores. The name cannot start with a double underscore. The length of label value must not exceed 256 characters.
Required |
Editable |
Datatype |
Valid values |
---|---|---|---|
Yes |
Yes |
Dict |
List of valid labels (see the parameter description) |