Writing metrics to Monitoring

Monitoring allows you to collect and store metrics and display them as charts on dashboards. Data sent to Monitoring represents measured values (metrics) and labels that describe them.

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

Example of writing metrics from Yandex Query to Monitoring:

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

Under streaming 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. Go to Connections in the Yandex Query interface and click Create new.

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

3. In the drop-down list under Type, select Monitoring.

4. In the Service account field, select the service account to use for metric writes. You can also create a new service account with the monitoring.editor permissions.

   To use a service account, the iam.serviceAccounts.user role is required.

5. Click Create to create a connection.

Data modelData model

Metrics are written to Monitoring using 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 contain a timestamp, metrics, and their labels.
• <query>: Yandex Query data source query.

Metrics are written using the write Monitoring API method. Pass the following when writing metrics:

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

Yandex Query automatically prints the semantics of parameters from the SQL query.

No other data types are allowed in the fields.

Example of writing metricsExample of writing metrics

Sample query 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:

Sample query execution result in Monitoring.