Правила записи

В Yandex Managed Service for Prometheus® вы можете использовать ваши существующие файлы с правилами записи (recording rules). Поддерживаются все поля, описанные в спецификации YAML-файла.

API представлен набором REST-ресурсов, которые находятся по адресу https://monitoring.api.cloud.yandex.net/prometheus/workspaces/<идентификатор_воркспейса>/extensions/v1/rules. Чтобы начать выполнять запросы:

1. Укажите идентификатор вашего воркспейса в адресе. Идентификатор воркспейса можно посмотреть в пользовательском интерфейсе Monitoring на вкладке Prometheus.
2. Установите cURL.
3. Аутентифицируйтесь в API.

Создать или заменить файл с правилами записиСоздать или заменить файл с правилами записи

1. Закодируйте содержимое файла в Base64 согласно RFC 4648:

   cat recording-rule.yaml
   
   # groups:
   #   - name: example
   #     rules:
   #     - record: example
   #       expr: up
   
   base64 -i recording-rule.yaml
   
   # Z3JvdXBzOgogIC0gbmFtZTogZXhhbXBsZQogICAgcnVsZXM6CiAgICAtIHJlY29yZDogZXhhbXBsZQogICAgICBleHByOiB1cA==
   

2. Сохраните результат в JSON-файл:

   body.json

   {
       "name": "recording-rules",
       "content" : "Z3JvdXBzOgogIC0gbmFtZTogZXhhbXBsZQogICAgcnVsZXM6CiAgICAtIHJlY29yZDogZXhhbXBsZQogICAgICBleHByOiB1cA=="
   }
   

3. Создайте или замените файл с правилами записи:

   export IAM_TOKEN=<IAM-токен>
   
   curl \
     --request PUT \
     --header "Content-Type: application/json" \
     --header "Authorization: Bearer ${IAM_TOKEN}" \
     --data "@body.json"  \
     "https://monitoring.api.cloud.yandex.net/prometheus/workspaces/<идентификатор_воркспейса>/extensions/v1/rules"
   

В случае успешного запроса будет возвращен HTTP-код 204, иначе — текст ошибки.

Если в результате замены файла были удалены правила или группы правил, они перестанут вычисляться. Все новые правила и группы правил начнут вычисляться.

Получить список файловПолучить список файлов

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

export IAM_TOKEN=<IAM-токен>

curl \
  --request GET \
  --header "Authorization: Bearer ${IAM_TOKEN}" \
  "https://monitoring.api.cloud.yandex.net/prometheus/workspaces/<идентификатор_воркспейса>/extensions/v1/rules"

Пример ответа:

{
  "files": [
    "recording-rules"
  ]
}

Посмотреть содержимое файлаПосмотреть содержимое файла

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

export IAM_TOKEN=<IAM-токен>

curl \
  --request GET \
  --header "Authorization: Bearer ${IAM_TOKEN}" \
  "https://monitoring.api.cloud.yandex.net/prometheus/workspaces/<идентификатор_воркспейса>/extensions/v1/rules/recording-rules"

Пример ответа:

{
  "name": "recording-rules",
  "content": "Z3JvdXBzOgogIC0gbmFtZTogZXhhbXBsZQogICAgcnVsZXM6CiAgICAtIHJlY29yZDogZXhhbXBsZQogICAgICBleHByOiB1cA=="
}

Просмотреть состояние вычисления файлаПросмотреть состояние вычисления файла

Вычисление каждого правила во всех группах файла можно получить, используя REST-ресурс snapshots. Каждый снимок содержит информацию о статусе, ошибке, имени правила и о том, как долго оно вычислялось.

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

export IAM_TOKEN=<IAM-токен>

curl \
  --request GET \
  --header "Authorization: Bearer ${IAM_TOKEN}" \
  "https://monitoring.api.cloud.yandex.net/prometheus/workspaces/<идентификатор_воркспейса>/extensions/v1/rules/recording-rules/snapshots"

Пример ответа:

{
  "snapshotByGroup": {
    "example": [
      {
        "state": "OK",
        "error": "",
        "evaluationTimeMs": 21,
        "evaluatedAtTimeEpochMs": 1710490243322,
        "record": "example"
      }
    ]
  }
}

Возможные состояния правила:

• NOT_EVALUATED_YET — файл загружен, но вычисление еще не началось.
• OK — успешное вычисление.
• LIMIT_EXCEEDED — правило вернуло больше временных рядов, чем разрешено в поле limit в YAML-файле. Для таких правил не сохраняется частичный результат вычислений.
• TIMEOUT — правило вычислялось слишком долго.
• UNEXPECTED_RESULT_TYPE — вычисление вернуло неожиданный результат, например строку.
• UNKNOWN_ERROR — общая ошибка, которая не может быть описана предыдущими состояниями.

Удалить файлУдалить файл

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

export IAM_TOKEN=<IAM-токен>

curl \
  --request DELETE \
  --header "Authorization: Bearer ${IAM_TOKEN}" \
  "https://monitoring.api.cloud.yandex.net/prometheus/workspaces/<идентификатор_воркспейса>/extensions/v1/rules/recording-rules"

© 2024 Linux Foundation. Все права защищены. Linux Foundation зарегистрировала товарные знаки и использует товарные знаки. Список товарных знаков Linux Foundation см. на странице Trademark Usage.