Spec-Zone.ru › OpenTSDB

/api/rollup

Этот конечный пункт позволяет хранить свернутые и/или предварительно агрегированные данные в OpenTSDB по протоколу HTTP. Для получения подробной информации о сворках и предварительной агрегации, обратитесь к руководству пользователя: Сводки и предварительные агрегаты.

Также ознакомьтесь с документацией /api/put для заметок и общих параметров, используемых в конечном пункте /api/rollup. На этой странице представлены различия между ними.

Глаголы

  • POST

Запросы

Значения свертки и предварительной агрегации являются расширениями объекта put с тремя дополнительными полями. Для полноты, все поля перечислены ниже:

Имя Тип данных Обязательно Описание Значение по умолчанию QS RW Пример
metric Строка Обязательно Имя метрики, которую вы храните W sys.cpu.nice
timestamp Целое число Обязательно Маркер времени в формате эпохи Unix в секундах или миллисекундах. Маркер времени не должен содержать нечисловых символов. W 1365465600
value Целое число, дробное число, строка Обязательно Значение для записи для этой точки данных. Оно может быть заключено в кавычки или нет и должно соответствовать правилам значений OpenTSDB: ../../user_guide/writing W 42.5
tags Карта Обязательно Карта пар «имя тега/значение тега». Должна быть указана хотя бы одна пара. W {"host":"web01"}
interval Строка Необязательно* Интервал времени, отражающий временной промежуток, который представляет собой значение сводки. Интервал состоит из <amount><unit> аналогично функции понижения частоты дискретизации или относительному метке времени запроса. Например, 6h для 5 часов данных, 30m для 30 минут данных. W 1h
aggregator Строка Необязательно* Функция агрегирования, используемая для генерации значения сводки. Должна соответствовать функции агрегирования TSDB. W SUM
groupByAggregator Строка Необязательно* Функция агрегирования, используемая для генерации значения предварительной агрегации. Должна соответствовать функции агрегирования TSDB. W COUNT

Хотя агрегаторы и интервал отмечены как необязательные выше, для записи данных необходимо удовлетворить как минимум одно из нижеприведенных сочетаний.

interval aggregator groupByAggregator Описание
Установлено Установлено Пусто Данные представляют собой сырую или не предварительно агрегированную сводку за указанный интервал.
Пусто Пусто Установлено Данные представляют собой сырое значение предварительной агрегации, которое не было свернуто по времени.
Установлено Установлено Установлено Данные представляют собой свернутое предварительно агрегированное значение.

Пример с одной точкой данных

Вы можете предоставить одну точку данных в запросе:

{
  "metric": "sys.cpu.nice",
  "timestamp": 1346846400,
  "value": 18,
  "tags": {
     "host": "web01",
     "dc": "lga"
  },
  "interval": "1h",
  "aggregator": "SUM",
  "groupByAggregator", "SUM"
}

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

Несколько точек данных должны быть заключены в массив:

[
  {
    "metric": "sys.cpu.nice",
    "timestamp": 1346846400,
    "value": 18,
    "tags": {
       "host": "web01",
       "dc": "lga"
    },
    "interval": "1h",
    "aggregator": "SUM",
    "groupByAggregator", "SUM"
  },
  {
    "metric": "sys.cpu.nice",
    "timestamp": 1346846400,
    "value": 9,
    "tags": {
       "host": "web02",
       "dc": "lga"
    },
    "interval": "1h",
    "aggregator": "SUM",
    "groupByAggregator", "SUM"
  }
]

Ответ

Обработка ответов производится аналогично конечной точке /api/put.

© 2010–2016 The OpenTSDB Authors
Licensed under the GNU LGPLv2.1+ and GPLv3+ licenses.
http://opentsdb.net/docs/build/html/api_http/rollup.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API