Рекомендуется предварительно установить Java. Для работы ES необходима 8 версия Java.

Установка из подключенных репозиториев

Версией Java по умолчанию должна стать 8-я, поэтому выполняем в следующем порядке:

aptitude install oracle-java8-installer

Для того, чтобы проверить, что Java по умолчанию 8-я, выполняем команду:

java -version

Вывод должен быть таким:

java version "1.8.0_111"
Java(TM) SE Runtime Environment (build 1.8.0_111-b14)
Java HotSpot(TM) 64-Bit Server VM (build 25.111-b14, mixed mode)

Если Java по умолчанию получила другую версию, выводим список установленных версий, выполнив команду:

update-java-alternatives --list

Список установленных версий будет выведен в следующем виде:

java-1.7.0-openjdk-amd64 1071 /usr/lib/jvm/java-1.7.0-openjdk-amd64
java-8-oracle 1081 /usr/lib/jvm/java-8-oracle

Переключим версию на нужную, выполнив команду:

update-java-alternatives --set java-8-oracle

Установка из ранее скачанного архива аналогична описанной в Руководстве администратора.

В консоли сервера, предназначенного для работы ES, выполните команду:

aptitude install elasticsearch

Будет установлен пакет ES.

Запуск ES осуществляется командой:

/etc/init.d/elasticsearch start

Команды остановки, перезапуска и проверки статуса ES аналогичны используемым для jboss:

По умолчанию ES доступен по адресу localhost:9200. Изменить эту настройку можно в файле /etc/elasticsearch/elasticsearch.yml.

Проверить запуск ES можно, перейдя в браузере по адресу localhost:9200 либо выполнив команду:

curl localhost:9200

Вывод должен быть таким:

{
  "name" : "RFSWkzt",
  "cluster_name" : "elasticsearch",
  "cluster_uuid" : "r67YbmerQvyNHdxlzDIt3A",
  "version" : {
    "number" : "5.1.2",
    "build_hash" : "c8c4c16",
    "build_date" : "2017-01-11T20:18:39.146Z",
    "build_snapshot" : false,
    "lucene_version" : "6.3.0"
  },
  "tagline" : "You Know, for Search"
}

Для комплексной установки Java8 и Elasticsearch необходимо установить общий пакет:

aptitude install arta-synergy-indexator-elasticsearch

Этот пакет по зависимостям установит пакеты oracle-java8-installer и elasticsearch, а также установит версию Java по умолчанию и настроит конфигурационные файлы.

В консоли сервера выполните команду:

aptitude install kibana

По умолчанию Kibana запускается по адресу localhost:5601, адрес используемого ES - localhost:9200.

Для обеспецения безопасности данных мы настоятельно рекомендуем изменить эти настройки и использовать вместо порта 5601 адрес <host>/kibana. Эти настройки указываются в конфигурационном файле Kibana: /etc/kibana/kibana.yml.

Если необходимо, чтобы Kibana была доступна по локальной сети, нужно изменить параметр server.host, указав для него IP-адрес сервера Kibana и раскомментировав соответствующую строку:

    # Kibana is served by a back end server. This setting specifies the port to use.
    #server.port: 5601

    # Specifies the address to which the Kibana server will bind. IP addresses and host names are both valid values.
    # The default is 'localhost', which usually means remote machines will not be able to connect.
    # To allow connections from remote users, set this parameter to a non-loopback address.
    server.host: "127.0.0.1"

    # Enables you to specify a path to mount Kibana at if you are running behind a proxy. This only affects
    # the URLs generated by Kibana, your proxy is expected to remove the basePath value before forwarding requests
    # to Kibana. This setting cannot end in a slash.
    server.basePath: "/kibana"

    # The maximum payload size in bytes for incoming server requests.
    #server.maxPayloadBytes: 1048576

    # The Kibana server's name.  This is used for display purposes.
    #server.name: "your-hostname"

    # The URL of the Elasticsearch instance to use for all your queries.
    #elasticsearch.url: "http://localhost:9200"

    # When this setting’s value is true Kibana uses the hostname specified in the server.host
    # setting. When the value of this setting is false, Kibana uses the hostname of the host
    # that connects to this Kibana instance.
    #elasticsearch.preserveHost: true

Запуск Kibana осуществляется командой:

/etc/init.d/kibana start

Команды остановки, перезапуска и проверки статуса Kibana аналогичны используемым для jboss и ES.

Kibana не имеет встроенных средств для контроля доступа: при переходе по адресу любой пользователь имеет полные права на запись, редактирование и удаление данных. Если требуется обеспечение защиты, предлагаем использовать средства nginx reverse proxy.

Ниже приведём пример с установкой защиты от входа в модуль при помощи web-сервера nginx, его модулей http_auth_request_module, headers-more-nginx-module и метода REST API Synergy rest/api/auth/{role}. Будем предполагать, что используется стандартный конфигурационный файл для nginx, поставляемый вместе с Synergy, synergy-base.

# aptitude install nginx-extras

# editor /etc/nginx/sites-enabled/synergy-base

[ ... ]

server {
    server_name synergy.arta.pro; #DO NOT CHANGE. use dpkg-reconfigure arta-synergy-synergy
    
    [ ... ]

    # Новый location, используемый для аутентификации
    location = /auth-kibana {
        proxy_pass              http://127.0.0.1:8080/Synergy/rest/api/auth;
        more_set_headers -s 401 'WWW-Authenticate: Basic';
        proxy_pass_request_body off;
        proxy_set_header        Content-Length "";
        proxy_set_header        X-Original-URI $request_uri;
    }

    # И в секцию, которая соответствует Kibana
    location ~ ^/kibana/(.*)$ {
        rewrite /kibana/(.*) /$1 break;
        proxy_pass http://127.0.0.1:5601;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection 'upgrade';
        proxy_set_header Host $host;
        proxy_cache_bypass $http_upgrade;
        auth_request  /auth-kibana;
    }
    [ ... ]

}

# /etc/init.d/nginx reload
# /etc/init.d/kibana restart

Таким образом, для каждого реестра и для каждой формы, по которым есть данные, будет создано по индексу. Если по форме создан реестр, а также созданы какие-то данные вне реестра, то в этом случае будет создано два индекса:

Кроме этого, для удобства использования и возможности переноса конфигурации для каждого из вышеперечисленных индексов создаётся alias. Имена alias-ов формируются так:

Одна единица данных в индексе Elasticsearch называется Документ. Документ содержит поля определённых типов. Каждый документ в текущем индексе соответствует одной единице данных по форме (=файлу по форме, записи реестра) и содержит следующие поля:

Далее следуют поля, соответствующие компонентам формы:

Постфиксы для полей *_key:

Постфиксы для полей *_value:

Индексы изменения данных создаются только для тех форм и реестров, коды которых подпадают под шаблоны (секции в конфигурационном файле arta/elasticConfiguration.xml, см. описание выше).

Имя индекса <index-prefix>-rh-someRegistryID и <index-prefix>-fh-someFormID, для реестров и форм, соответственно. Alias-ы: rh-нормализованный_код_реестра и fh-нормализованный_код_формы.

Отличие индексов изменения данных от текущих индексов - на каждое изменение данных по форме создаётся новый документ в индексе. Кроме этого, для компонентов формы создаются только поля со следующими постфиксами:

Типы данных и условия создания полей такие же, как и в текущем индексе.

Все диаграммы создаются в разделе Visualize:

Рисунок 1.21. Kibana, раздел Visualize

В общем случае, процесс создания диаграмм состоит из трех шагов:

В настоящем документе процесс создания диаграмм и дашбордов будет рассмотрен на примере анализа данных формы «Заявка»:

Рисунок 1.25. Форма «Заявка»

Рисунок 1.26. Создание диаграммы Pie chart

Для диаграммы Pie chart возможно два способа организации используемых параметров:

Добавить новый параметр можно, нажав на кнопку Add sub-buckets.

Вкладка Options для этого типа диаграмм содержит три параметра:

Рисунок 1.29. Вкладка «Опции» диаграммы Pie chart

Рисунок 1.30. Создание диаграммы Data table

В разделе Metrics необходимо указать одну или несколько метрик, по которым будут агрегироваться данные в таблице.

В разделе Buckets необходимо указать используемые параметры и способы их агрегации. Для этого типа диаграмм также существует два способа организации входных параметров:

Функциональность этих способов полностью аналогична Split Slices и Split Chart для круговой диаграммы.

Рисунок 1.31. Настроены отображаемые данные в таблице

Вкладка Options для этого типа диаграмм содержит следующие параметры:

Рисунок 1.32. Вкладка «Опции» диаграммы Data table

Рисунок 1.33. Создание диаграммы Vertical bar chart

В диаграмме этого типа по оси Y располагаются метрики (параметры в Metrics), с по оси X - группы (параметры в Buckets).

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

Функциональность Split Bars и Split Chart полностью аналогична Split Slices и Split Chart для круговой диаграммы.

Рисунок 1.34. Диаграмма Vertical bar chart, пример 1

На примере 1 показан результат разделения параметров по диаграммам: отображается количество заявок, поданных разными авторами и выполненных разными исполнителями. Для этого исполнители расположены по оси Х, а для каждого автора заявок отрисована отдельная диаграмма.

Рисунок 1.35. Диаграмма Vertical bar chart, пример 2

На примере 2 показана простая гистограмма, визуализирующая количество заявок, выполненных разными исполнителями.

Специфичный тип диаграммы, который не имеет раздела Data. В левой части рабочей области располагается поле ввода текста с использованием синтаксиса языка Markdown, в правой части отображается результат разметки текста:

Рисунок 1.36. Создание Markdown widget

Эта диаграмма не имеет никаких особых настроек.

Диаграмма Metric работает только с числовыми данными, поэтому для нее доступны только агрегации типа Metrics:

Рисунок 1.37. Создание Metrics

Добавить новую метрику можно, нажав на кнопку Add metrics. Новая метрика будет добавлена как новое отображаемое число.

Вкладка Options для этого типа диаграмм содержит только один параметр - размер шрифта:

Рисунок 1.38. Вкладка «Опции» диаграммы Metrics

Рисунок 1.39. Создание Tag cloud

В диаграмме Tag cloud возможно использование только одной агрегации Metrics и только одного, специального способа организации данных в Buckets - Tags. Добавление новых метрик или новых групп недоступно.

Рисунок 1.40. Пример диаграммы Tag cloud

Вкладка Options содержит следующие параметры:

Рисунок 1.41. Вкладка «опции» диаграммы Tag cloud

Для добавления ранее сохраненной диаграммы на дашборд необходимо выбрать пункт меню Add. Отобразится список доступных диаграмм (илл. «Добавление диаграммы на дашборд» выше). Необходимо кликнуть на нужную диаграмму - она будет добавлена на дашборд:

Рисунок 1.46. Добавлена панель диаграммы на дашборд

Размер отображаемой диаграммы можно изменить, потянув за левый нижний угол панели диаграммы:

Рисунок 1.47. Изменение размера панели диаграммы

Рисунок 1.48. Изменен размер панели диаграммы

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

На панели диаграммы отображаются пиктограммы управления:

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

Пример готового дашборда:

Рисунок 1.50. Пример готового дашборда в режиме редактирования

Типы использованных примеров диаграмм (перечислены сверху вниз, слева направо):

Kibana предоставляет способы публикации дашборда как интерактивной диаграммы или как снимка его состояния на момент публикации (shapshot). Публикация производится в меню Share:

Рисунок 1.51. Пункт меню «Share»

Встраивание как дашборда, так и его снимка возможно двумя способами:

Один из способов публикации дашборда в Synergy - добавление его как внешнего модуля. При этом каждый дашборд должен быть оформлен как отдельный внешний модуль. В качестве адреса приложения необходимо использовать URL дашборда.

Другой способ - включение фрейма с дашбордом в пользовательский компонент. В этом случае в качестве HTML-кода необходимо использовать код из поля Embedded iframe.

Рисунок 1.52. Пример дашборда, опубликованного как внешний модуль

Рисунок 1.53. Запрос пароля при просмотре дашборда

Логин и пароль достаточно ввести один раз в течении сессии.