Writing metrics to Monitoring

Monitoring is a service that collects, stores, and presents metrics on dashboards. The data that goes to Monitoring contains the measured quantity values ​​(metrics) and the labels describing them.

For example, to count app failures, you can use failure count during time interval as the metric. Host name and application version at the time of failure are labels. In the Monitoring interface, you can aggregate metrics by labels.

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 set up sending metrics to Monitoring:

1. Navigate to Yandex Query.

2. In the left-hand panel, select Connections.

3. Click Create new.

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

5. In the Type field, select Monitoring.

6. In the Service account field, select the service account you will use to write metrics, or create a new one and assign the monitoring.editor role to it.

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

7. Click Create.

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 section.
• <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. Provide the following data:

• Timestamp.
• List of metrics and their types: Yandex Query supports the DGAUGE and IGAUGE 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: