Плагин для платформы Grafana

Плагин OT.Platform plugin осуществляет взаимодействие платформы Grafana с API WDC.Платформа.

Важно!
Для корректной работы плагина рекомендуется использовать Grafana версии 7 и выше.

Плагин поставляется в составе архива tar.gz, в котором размещены:

• otp-grafana-datasource – папка с бинарными файлами плагина и папкой, содержащей иконку плагина, которая будет отображаться в списке доступных источников данных непосредственно в интерфейсе Grafana. Среди обязательных файлов плагина выделим следующие:

  module.js – файл, содержащий настройки конфигурации плагина в Grafana;

  plugin.json – файл с идентификатором плагина;

  otp-grafana-datasource_{​идентификатор архитектуры операционной системы}, например, "otp-grafana-datasource_linux_amd64".

• changelog.md – файл с историей изменений, вносимых в плагин;

• license.md – файл лицензии, под которой поставляется плагин;

• readme.md – файл с кратким описанием назначения плагина, его установки, настройки и использования.

В процессе взаимодействия плагин выполняет логирование в WDC.Платформа, отправку OTL-запросов, получение результатов и обработку данных для отображения в визуализациях Grafana.

Подготовка плагина к работе ведётся в 2 этапа:

1. Установка и настройка плагина.

2. Настройка источника данных в Grafana.

Установка и настройка плагина

Установка и настройка плагина выполняется в 3 этапа:

Этап 1.

Перенесите дистрибутивную папку otp-grafana-datasource в папку с плагинами Grafana.

Примечание. Стандартный путь к папке Grafana с подключенными плагинами: ../var/lib/grafana/plugins.

Этап 2.

В секции [plugins] конфигурационного файла Grafana grafana.ini укажите id плагина – otp-grafana-datasource – в поле allow_loading_unsigned_plugins

Примечание. Стандартный путь до файла: ../etc/grafana/grafana.ini. Id плагина – см. в файле plugin.json.

Пример:

...

[plugins]

...

allow_loading_unsigned_plugins = otp-grafana-datasource

Этап 3.

Выполните перезагрузку Grafana.

После чего в Grafana найдите меню  :

И на вкладке "Data Sources" по кнопке "Add data source" будет выведен список доступных источников данных, в котором, среди прочих, станет доступен новый плагин источника данных:

Нажатием кнопки “Select” добавьте его в список источников данных:

Настройка источника данных в Grafana

Дальнейшая работа по настройке плагина OT.Platform в качестве источника данных ведётся непосредственно в Grafana.

Теперь созданный плагином источник данных необходимо настроить. В форме конфигурации источника данных требуется задать значения для нескольких обязательных полей.

Обязательные для ввода поля конфигурации:

• Данные для формирования URL-адреса, по которому будет выполняться обращение к WDC.Платформе:

  • Server URL – ip-адрес или домен.
    Если для обращения к WDC.Платформе используется порт, отличный от 80 порт, то его необходимо указать через двоеточие после ip-адреса или доменного имени.

    Примечание.
    Результаты вычисления WDC.Платформе предоставляются в виде
    статических файлов, поэтому порт, отличный от 80, следует
    указывать только в том случае, если WDC.Платформа на этом
    порту также обслуживает и директорию с результатами,
    предоставляя её по адресу: http(s)://\<platform url>/cache/…

    Пример:
    Если OT.Platform обслуживается на localhost, порт 50000,
    то следует указать:
    127.0.0.1:50000

  • Протокол взаимодействия с API.
    Поле заполняется с помощью выпадающего списка. Значение по умолчанию: HTTP.
    В результате для обращения к API платформы URL-адрес будет формироваться по шаблону:
    \<протокол взаимодействия>://\<Server URL>

  • Login – имя пользователя, который может работать с WDC.Платформой.

• Password – пароль пользователя, который может работать с ОТ.Platform.
  Содержимое поля скрывается после сохранения настроек, но хранится в системе.

  По кнопке “Reset” выполняется удаление содержимого поля Password.

Остальные поля преднастроены и корректируются по необходимости:

• CacheTTL – количество секунд хранения кеша результатов работы платформы (в секундах). Подробнее о работе кеша см. документацию к WDC.Платформе.

• Check delay – период отправки запроса для проверки наличия результатов вычисления запроса (в секундах).

• Job timeout – время проверки жизнеспособности задачи (Job) в очереди на выполнение в WDC.Платформу (в секундах).

• HTTP Timeout – количество секунд ожидания ответа на http-запросы к REST API.

• Time to “new” – время принятия в работу новой задачи (в секундах).
  Между ответом WDC.Платформы на запрос о создании задачи и принятием её в работу присутствует задержка. Значение, указанное в поле, предназначено для компенсации этой задержки.
  Его следует изменить в том случае, если возникает ошибка “Incorrect job status: notfound” или время получения результата выше ожидаемого.

• Time to “running” – время, по истечении которого у задачи будет изменён статус с “new” на “running”.

По кнопке “Delete” настраиваемый источник данных удаляется.

При нажатии на кнопку “Save & Test” по сформированному URL-адресу выполняется запрос на авторизацию с заданными логином и паролем. В случае успешной авторизации настройки сохраняются, и на экран будет выведено сообщение “Success”.

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

Пример.