Облачная платформаEvolution

Получить метаданные метрик

Эта статья полезна?

Примечание

API сервиса находится на стадии Preview.

По метрикам, записываемым в проект, можно получить информацию:

Получить список метрик

Чтобы получить cписок объектов, содержащих пары ключ-значение меток, которые идентифицируют каждую таймсерию:

  1. Выполните запрос:

    curl -G 'https://monitoring.api.cloud.ru/v2/{project_id}/metrics_meta' \
    --data-urlencode 'selector={__name__="balloonpct"}' \
    --data-urlencode 'start=now-1h5m' \
    --data-urlencode 'end=now' \
    -H "Authorization: Bearer $TOKEN"

    Где:

    • {project_ID} — идентификатор проекта.

    • selector — cелектор таймсерий в формате Prometheus, например: http_requests_total или http_requests_total{method=~"(GET|POST)"}.

    • (Опционально) start — начало временного интервала, за который необходимо получить данные.

    • (Опционально) end — конец временного интервала, за который необходимо получить данные.

    Опциональные временные параметры start и end поддерживают следующие форматы:

    • Unix-время в секундах с опциональным указанием миллисекунд после запятой, например: 1562529662.678.

    • Unix-время в миллисекундах, например: 1562529662678.

    • Unix-время в микросекундах, например: 1562529662678901.

    • Unix-время в наносекундах, например: 1562529662678901234.

    • Формат RFC3339, например: 2022-03-29T01:02:03Z или 2022-03-29T01:02:03+02:30.

    • Частичный формат RFC3339, например: 2022, 2022-03, 2022-03-29, 2022-03-29T01, 2022-03-29T01:02, 2022-03-29T01:02:03.

    • Относительная продолжительность по сравнению с текущим временем, например: 1h5m, -1h5m или now-1h5m, где -1h5m означает «один час и пять минут назад», а now — «сейчас».

    Подробное описание параметров читайте в справочнике API.

В ответ на запрос вернутся данные о метриках за указанный временной интервал.

Получить список ключей меток

  1. Выполните запрос:

    curl -G 'https://monitoring.api.cloud.ru/v2/{project_id}/metrics_meta/labels' \
    --data-urlencode 'selector={__name__="balloonpct"}' \
    --data-urlencode 'start=now-1h5m' \
    --data-urlencode 'end=now' \
    -H "Authorization: Bearer $TOKEN"

    Где:

    • {project_ID} — идентификатор проекта.

    • selector — cелектор таймсерий в формате Prometheus, например: http_requests_total или http_requests_total{method=~"(GET|POST)"}.

    • (Опционально) start — начало временного интервала, за который необходимо получить данные.

    • (Опционально) end — конец временного интервала, за который необходимо получить данные.

    Опциональные временные параметры start и end поддерживают следующие форматы:

    • Unix-время в секундах с опциональным указанием миллисекунд после запятой, например: 1562529662.678.

    • Unix-время в миллисекундах, например: 1562529662678.

    • Unix-время в микросекундах, например: 1562529662678901.

    • Unix-время в наносекундах, например: 1562529662678901234.

    • Формат RFC3339, например: 2022-03-29T01:02:03Z или 2022-03-29T01:02:03+02:30.

    • Частичный формат RFC3339, например: 2022, 2022-03, 2022-03-29, 2022-03-29T01, 2022-03-29T01:02, 2022-03-29T01:02:03.

    • Относительная продолжительность по сравнению с текущим временем, например: 1h5m, -1h5m или now-1h5m, где -1h5m означает «один час и пять минут назад», а now — «сейчас».

    Подробное описание параметров читайте в справочнике API.

Получить список значений для ключей меток

  1. Выполните запрос:

    curl -G 'https://monitoring.api.cloud.ru/v2/{project_id}/metrics_meta/labels/{label}/values' \
    --data-urlencode 'selector={__name__="balloonpct"}' \
    --data-urlencode 'start=now-1h5m' \
    --data-urlencode 'end=now' \
    -H "Authorization: Bearer $TOKEN"

    Где:

    • {label} — название метки.

    • {project_ID} — идентификатор проекта.

    • selector — cелектор таймсерий в формате Prometheus, например: http_requests_total или http_requests_total{method=~"(GET|POST)"}.

    • (Опционально) start — начало временного интервала, за который необходимо получить данные.

    • (Опционально) end — конец временного интервала, за который необходимо получить данные.

    Опциональные временные параметры start и end поддерживают следующие форматы:

    • Unix-время в секундах с опциональным указанием миллисекунд после запятой, например: 1562529662.678.

    • Unix-время в миллисекундах, например: 1562529662678.

    • Unix-время в микросекундах, например: 1562529662678901.

    • Unix-время в наносекундах, например: 1562529662678901234.

    • Формат RFC3339, например: 2022-03-29T01:02:03Z или 2022-03-29T01:02:03+02:30.

    • Частичный формат RFC3339, например: 2022, 2022-03, 2022-03-29, 2022-03-29T01, 2022-03-29T01:02, 2022-03-29T01:02:03.

    • Относительная продолжительность по сравнению с текущим временем, например: 1h5m, -1h5m или now-1h5m, где -1h5m означает «один час и пять минут назад», а now — «сейчас».

    Подробное описание параметров читайте в справочнике API.

Получить список имен метрик

  1. Выполните запрос:

    curl -G 'https://monitoring.api.cloud.ru/v2/{project_id}/metrics_meta/names' \
    --data-urlencode 'selector={method=~"(GET|POST)"}' \
    --data-urlencode 'start=now-1h5m' \
    --data-urlencode 'end=now' \
    -H "Authorization: Bearer $TOKEN"

    Где:

    • {project_ID} — идентификатор проекта.

    • selector — cелектор таймсерий в формате Prometheus, например: http_requests_total или http_requests_total{method=~"(GET|POST)"}.

    • (Опционально) start — начало временного интервала, за который необходимо получить данные.

    • (Опционально) end — конец временного интервала, за который необходимо получить данные.

    Опциональные временные параметры start и end поддерживают следующие форматы:

    • Unix-время в секундах с опциональным указанием миллисекунд после запятой, например: 1562529662.678.

    • Unix-время в миллисекундах, например: 1562529662678.

    • Unix-время в микросекундах, например: 1562529662678901.

    • Unix-время в наносекундах, например: 1562529662678901234.

    • Формат RFC3339, например: 2022-03-29T01:02:03Z или 2022-03-29T01:02:03+02:30.

    • Частичный формат RFC3339, например: 2022, 2022-03, 2022-03-29, 2022-03-29T01, 2022-03-29T01:02, 2022-03-29T01:02:03.

    • Относительная продолжительность по сравнению с текущим временем, например: 1h5m, -1h5m или now-1h5m, где -1h5m означает «один час и пять минут назад», а now — «сейчас».

    Подробное описание параметров читайте в справочнике API.