Writing metrics to Monitoring

Monitoring allows you to collect and store metrics, as well as display them as charts on dashboards. Data sent to Monitoring includes metrics and their descriptive labels.

For example, to track application failures, you can use the failure count per time interval as a metric. Data describing a failure, e.g., a host name and application version, serve as labels. The Monitoring interface allows you to aggregate metrics by label.

Query example for writing metrics from Yandex Query into Monitoring

INSERT INTO `monitoring`.custom
SELECT
	`my_timestamp`,
	host_name,
	app_version,
	exception_count,
	"exception_monitor" as service_type
FROM $query;

During stream processing, Yandex Query can send query results to Monitoring as metrics and their labels.

Setting up a connectionSetting up a connection

To send metrics to Monitoring:

1. Navigate to the Connections section of the Yandex Query interface and click Create new.

2. In the window that opens, specify the Monitoring connection name in the Name field.

3. In the Type dropdown, select Monitoring.

4. In the Service account field, select an existing service account or create a new one. Assign it the monitoring.editor permissions allowing it to write metrics.

   To use the service account on your behalf, you need the iam.serviceAccounts.user role.

5. Click Create to create a connection.

Data modelData model

To write metrics to Monitoring, use the following SQL statement:

INSERT INTO 
	<connection>.custom 
SELECT 
	<fields> 
FROM 
	<query>;

Where:

• <connection>: Name of the Monitoring connection created in the previous step.
• <fields>: List of fields that include a timestamp, metrics, and their labels.
• <query>: Yandex Query source data query.

To write metrics, use the write Monitoring API method. When writing metrics, provide the following information:

• Timestamp.
• List of metrics and their types. Yandex Query supports DGAUGE and IGAUGE metric types.
• List of labels.

Yandex Query automatically infers parameter semantics from the SQL query.

No other data types are permitted in these fields.

Metrics writing exampleMetrics writing example

Query example for writing metrics from Yandex Query to Monitoring:

INSERT INTO 
	`monitoring`.custom
SELECT
	`my_timestamp`,
	host AS host_name,
	app_version,
	exception_count,
	"exception_monitor" as service_type
FROM $query;

Where:

Example of query results in Monitoring: