/api/put

Этот конечный пункт позволяет хранить данные в OpenTSDB по протоколу HTTP как альтернативу интерфейсу Telnet. Запросы PUT могут выполняться только с содержимым, связанным с методом POST. Формат содержимого зависит от выбранного сериализатора. Однако есть некоторые общие параметры и ответы, как документировано ниже.

Для экономии пропускной способности API put позволяет клиентам хранить несколько точек данных в одном запросе. Точки данных не обязательно должны быть связаны каким-либо образом. Каждая точка данных обрабатывается индивидуально, и ошибка с одной точкой данных не повлияет на хранение корректных данных. Это означает, что если ваш запрос содержит 100 точек данных, а одна из них имеет ошибку, 99 точек данных все равно будут записаны, а одна будет отклонена. Подробности определения точки данных, которая не была сохранена, см. в разделе «Ответ» ниже.

Хотя API поддерживает несколько точек данных на запрос, API не вернет ответ, пока не обработает каждую из них. Это означает, что имена/значения метрик и тегов должны быть проверены, значение обработано, а данные помещены в очередь на хранение. Если ваш запрос PUT содержит большое количество точек данных, API может долго отвечать, особенно если OpenTSDB должен назначить идентификаторы (UID) именам или значениям тегов. Поэтому рекомендуется ограничить максимальное количество точек данных в запросе; 50 точек на запрос — хорошее начальное значение.

Еще одна рекомендация — включить keep-alives в вашем HTTP-клиенте, чтобы вы могли повторно использовать ваше подключение к серверу каждый раз при отправке данных.

Глаголы

• POST

Запросы

Можно передавать некоторые параметры строки запроса, которые изменяют ответ на запрос PUT:

Если оба detailed и summary присутствуют в строке запроса, API вернет информацию detailed.

Поля и примеры ниже относятся к сериализатору JSON по умолчанию.

{
  "metric": "sys.cpu.nice",
  "timestamp": 1346846400,
  "value": 18,
  "tags": {
     "host": "web01",
     "dc": "lga"
  }
}

[
  {
    "metric": "sys.cpu.nice",
    "timestamp": 1346846400,
    "value": 18,
    "tags": {
       "host": "web01",
       "dc": "lga"
    }
  },
  {
    "metric": "sys.cpu.nice",
    "timestamp": 1346846400,
    "value": 9,
    "tags": {
       "host": "web02",
       "dc": "lga"
    }
  }
]

Ответ

По умолчанию конечный пункт PUT вернет код HTTP 204 и пустое содержимое, если все точки данных были успешно сохранены. Если одна или несколько точек данных содержали ошибку, API вернет код 400 с сообщением об ошибке в содержимом.

Для отладки вы можете запросить включение в ответ сводной информации о количестве успешно и неудачно сохраненных точек данных или получить детали о точках данных, которые не были сохранены, и причинах, чтобы вы могли исправить свой код клиента. Также ошибки с точкой данных будут записаны в журнале TSD, поэтому вы можете там найти проблемы.

Поля, присутствующие в ответах summary или detailed, включают:

{
  "failed": 1,
  "success": 0
}

{
  "errors": [
    {
      "datapoint": {
        "metric": "sys.cpu.nice",
        "timestamp": 1365465600,
        "value": "NaN",
        "tags": {
          "host": "web01"
        }
      },
      "error": "Unable to parse value to a number"
    }
  ],
  "failed": 1,
  "success": 0
}