.. _Integration_Telemetry_GrafanaSample:

Настройка вывода метрик в Grafana
#################################

В качестве примера инструментария для вывода метрик будет использована `Grafana <https://grafana.com/>`_.

Установка Grafana
*****************

Для установки необходимо скачать с `официального сайта <https://grafana.com/get/?tab=self-managed>`_ дистрибутив Grafana.
После этого нужно запустить установку скачанного дистрибутива и следовать инструкциям установщика.

Создание Dashboard для Prometheus
*********************************

После установки нужно перейти в `Dashboard Grafana <http://localhost:3000/>`_.
Далее перейти в раздел ``Dashboards`` и нажать кнопку ``Create dashboard`` для добавления Dashboard с выводом необходимой информации.

.. image:: img/Grafana-Dashboard-Creation.png
   :scale: 31
   :align: center
   :name: Создание Dashboard

В открывшемся окне нажать кнопку ``Add visualization`` и выбрать источник данных ``prometheus``.

.. image:: img/Grafana-Data-Source-Selection.png
   :scale: 49
   :align: center
   :name: Выбор источника данных для Dashboard

После этого можно выводить в ``Dashboard`` необходимые данные.

Вывод графика по длительности выполнения запроса
************************************************

Для вывода графика необходимо указать промежуток времени, за который нужно просмотреть запрос, а также задать наименование метрики и фильтры по ее тегам:

* ``terralink_xde_request_duration`` - наименование метрики;
* ``job`` - наименование сервиса, определенное в ``xde_metrics.yml``;
* ``handler_type`` - тип обработчика запроса.

.. image:: img/Grafana-Request-Duration-Sample.png
   :scale: 31
   :align: center
   :name: График по длительности выполнения запроса

Вывод гистограммы по размерам файлов в архиве
*********************************************

Для вывода гистограммы по размерам сохраненных файлов в архиве необходимо в редакторе запроса прописать: 

.. code-block:: console

    sum by(le) (terralink_xde_archive_file_size_bucket)

| После этого нужно установить ``Options`` > ``Format`` в ``Heatmap``.
| В правом верхнем углу в качестве типа визуализации выбрать ``Bar gauge``.

.. image:: img/Grafana-Archive-File-Size-Sample.png
   :scale: 37
   :align: center
   :name: Гистограмма по размерам файлов в архиве

На гистограмме видно, что в архиве было сохранено 38 файлов размером от 1 до 10 КБ и 1 файл размером от 10 до 50 МБ.