Устаревший HTTP API

Версия 1.0 OpenTSDB включала базовый HTTP API, который позволял запросить данные, предложить имена метрик или тегов, а также получить доступ к статическим файлам. API версии 1.0 перенесён в 2.0 для обеспечения обратной совместимости, хотя большинство вызовов устарели. Ниже приведён список различных конечных точек и способ их использования.

Если конечная точка помечена как (Устаревший) ниже, её не следует использовать в будущей разработке.

Общие сведения

Большинство конечных точек могут возвращать данные в одном или нескольких из следующих форматов:

• Обычный текст - Или ASCII, по умолчанию для многих запросов возвращается простая страница данных с типом содержимого text/plain
• HTML - Если запрос некорректен или произошла ошибка, ответ часто будет в формате HTML, жёстко закодированном и не использующем шаблоны
• JSON - Многие вызовы могут отвечать в формате JSON, если параметр json добавлен в строку запроса
• PNG - Некоторые запросы, включая исключения и ошибки, могут генерировать изображение. В этих случаях ошибка отправляется в GnuPlot, и возвращается полученная пустая диаграмма с заголовком, состоящим из сообщения. Добавьте параметр png в строку запроса.

Правильный тип содержимого возвращается для каждого ответа, например, text/html; charset=UTF-8 для HTML, application/json для JSON и image/png для изображений.

Выбор другого формата вывода выполняется с помощью параметра png или json строки запроса. Значение параметра игнорируется. Например, вы можете запросить http://localhost:4242/suggest?type=metrics&q=sys&json для получения данных в формате JSON.

/

Запрашивает корень, который представляет собой сгенерированный GWT интерфейс OpenTSDB. Эта конечная точка возвращает только HTML и не может возвращать другие данные.

/aggregators (Устаревший)

Возвращает список доступных функций агрегирования только в формате JSON. Другие форматы игнорируются. Этот метод не принимает параметры строки запроса.

Пример запроса:

http://localhost:4242/aggregators

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

["min","sum","max","avg"]

/diediedie (Устаревший)

Доступ к этой конечной точке заставляет TSD выполнить плавную остановку и выйти. Плавная остановка предотвращает потерю данных путём сброса всех буферизованных изменений в HBase перед выходом. Конечная точка не возвращает данных и не принимает параметров.

/dropcaches (Устаревший)

Очищает все внутренние кэши, такие как отображения UID к имени и имени к UID. Его следует использовать, если вы переименовали метрику, тег или значение тега.

/logs (Устаревший)

Возвращает последние строки, записанные TSD во внутренней системе, возвращая наиболее последние записи в первую очередь. OpenTSDB использует LogBack, и файл src/logback.xml должен иметь конфигурированный аппендер Cyclic Buffer для работы этой конечной точки. Конфигурация XML определяет, сколько строк будет возвращено при каждом вызове. Вывод по умолчанию — обычный текст с компонентами сообщения, разделенными табуляцией, или он может быть возвращён в формате JSON с соответствующим параметром строки запроса.

Эта конечная точка также может изменить уровень ведения журнала ______ во время выполнения. Параметр строки запроса для использования — level=<logging_level>. Например, вы можете вызвать http://localhost:4242/logs?level=INFO для установки уровня ведения журнала на INFO. Действительные значения параметров (от наиболее подробного к наименее): ALL TRACE DEBUG INFO WARN ERROR OFF (имена нечувствительны к регистру). Обратите внимание, что этот метод не изменяет файл конфигурации logback.xml и перезапуск TSD загрузит его из этого файла.

/q (Устаревший)

Запрашивает данные у TSD.

/s

Обслуживает статические файлы, такие как JavaScript, сгенерированный компилятором GWT, или favicon.ico. TSD нуждается в аргументе --staticroot или tsd.http.staticroot для запуска. Этот аргумент — путь к каталогу, содержащему файлы, обслуживаемые этой конечной точкой.

Когда поступает запрос на GET /s/queryui.nocache.js, файл ${staticroot}/queryui.nocache.js отправляется в браузер.

Примечание: TSD позволит клиентам кешировать статические файлы в течение 1 года по умолчанию и сообщит о возрасте файла на диске. Если имя файла содержит nocache, TSD сообщит клиентам, что они не должны кешировать этот файл (этот идиом используется GWT).

/stats (Устаревший)

Возвращает статистические данные о работающем TSD

/suggest (Устаревший)

Используется для автозаполнения вызовов для соответствия метрикам, именам тегов или значениям тегов заданному строковому значению. Возвращает только данные JSON.

Параметры:

• type - Тип значения для предложений. Должен быть либо metrics для метрик, tagk для имён тегов или tagv для значений тегов.
• q - Строка для сопоставления. Сопоставление чувствительно к регистру и соответствует только первым символам каждого типа данных. Например, type=metrics&q=sys вернёт только имена метрик, начинающиеся с sys, такие как sys.cpu.0.system
• max - Необязательное максимальное количество результатов для возврата. По умолчанию 25, и указанные значения должны быть больше 0.

Оба параметра обязательны, в противном случае вы получите исключение.

Пример запроса:

http://localhost:4242/suggest?type=metrics&q=df

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

[
  "df.1kblocks.free",
  "df.1kblocks.total",
  "df.1kblocks.used",
  "df.inodes.free",
  "df.inodes.total",
  "df.inodes.used"
]

/version (Устаревший)

Возвращает информацию о версии сборки работающего TSD. Может возвращаться как в формате по умолчанию — обычный текст, так и в формате JSON.