Elasticsearch

Последняя версия: 1.3.0

Дистрибутив: образ плагина Elasticsearch

Описание

Плагин Elasticsearch предназначен для выполнения запросов к индексам Elasticsearch: поиска, агрегаций и сценариев работы с временными рядами.

Источник данных настраивается через стандартную форму Графини. Для подключения можно использовать открытый доступ к кластеру или базовую аутентификацию через Имя пользователя и Пароль. При проверке соединения плагин выполняет запрос к Elasticsearch и проверяет доступность узла.

Настройка

Ниже приведены примеры формы создания источника данных Elasticsearch в интерфейсе Графини.

Базовая форма

Вариант с базовой аутентификацией

Вариант без проверки TLS

Поля источника данных

Название в UI	Код поля	Тип	Обязательность	Примечание
URL	url	text	обязательно	Адрес Elasticsearch, например https://elastic.example.local:9200
Имя пользователя	username	text	необязательно	Используется для базовой аутентификации
Пароль	password	password	необязательно	Используется вместе с полем Имя пользователя
Пропустить проверку TLS	skipTls	radio	обязательно	Триггерное поле со значениями Проверять и Игнорировать
TLS-сертификат	tls	textarea	необязательно	Отображается, если выбрано Проверять
Индекс	index	text	обязательно	Имя индекса или шаблон, например logs-*
Поле времени	timeField	text	необязательно	По умолчанию используется @timestamp
Версия	version	select	необязательно	Доступны варианты 7.17+ и 8.0+; по умолчанию выбрано 8.0+
TTL кэша	ttl	number	необязательно	В секундах; 0 отключает кэш; допустимый диапазон 0..43200
Лимит по умолчанию	defaultLimit	number	необязательно	Лимит документов по умолчанию, если размер запроса не задан; допустимый диапазон 0..10000, по умолчанию 500
Режим ввода запросов пользователем	codeMode	radio	обязательно	Значения Выключен и Включен
Язык ввода запросов пользователем	codeLang	text	необязательно	Служебное поле только для чтения; в интерфейсе отображается KQL

Динамические поля и зависимости

Главное триггерное поле в форме: Пропустить проверку TLS.

1. Если выбрано Проверять: отображается поле TLS-сертификат.

2. Если выбрано Игнорировать: поле TLS-сертификат скрывается.

Остальные поля формы отображаются постоянно. Поля Имя пользователя и Пароль не являются отдельным режимом аутентификации и просто дополняют подключение, если кластер Elasticsearch требует базовую авторизацию.

Правила заполнения, важные для проверки подключения

• Для успешной проверки соединения обязательно заполнить URL и Индекс.
• В поле Пропустить проверку TLS должно быть выбрано одно из значений: Проверять или Игнорировать.
• Если для подключения используется https и требуется проверка собственного сертификата, заполните поле TLS-сертификат.
• Если кластер требует авторизацию, рекомендуется заполнять Имя пользователя и Пароль парой.
• Поле Индекс должно содержать существующее имя индекса или корректный шаблон индексов.
• TTL кэша должен быть в диапазоне 0..43200.
• Лимит по умолчанию должен быть числом в диапазоне 0..10000.
• Проверка соединения зависит от доступности Elasticsearch по указанному URL; если адрес недоступен, сертификат не принят или авторизация неверна, проверка завершится ошибкой.

Порядок создания источника данных

1. Откройте раздел Источники данных и нажмите Добавление источника.
2. Заполните поле Источник данных понятным именем подключения.
3. В поле Тип выберите Elasticsearch.
4. Введите URL Elasticsearch.
5. При необходимости заполните Имя пользователя и Пароль.
6. В поле Пропустить проверку TLS выберите: Проверять, если нужно валидировать сертификат сервера; Игнорировать, если проверка сертификата не требуется.
7. Если выбрано Проверять и используется собственный сертификат, вставьте его в поле TLS-сертификат.
8. Заполните Индекс.
9. При необходимости скорректируйте Поле времени, Версия, TTL кэша, Лимит по умолчанию и Режим ввода запросов пользователем.
10. Нажмите Проверить соединение.
11. После успешной проверки нажмите Сохранить.

Пример заполнения

Подключение без аутентификации

• URL: https://elastic.example.local:9200
• Пропустить проверку TLS: Проверять
• TLS-сертификат: сертификат сервера, если используется собственный центр сертификации
• Индекс: logs-*
• Поле времени: @timestamp
• Версия: 8.0+
• TTL кэша: 600
• Лимит по умолчанию: 500
• Режим ввода запросов пользователем: Выключен

Подключение с базовой аутентификацией

• URL: https://elastic.example.local:9200
• Имя пользователя: grafina_reader
• Пароль: пароль пользователя Elasticsearch
• Пропустить проверку TLS: Проверять или Игнорировать в зависимости от схемы подключения
• Индекс: logs-*
• Поле времени: @timestamp

Подключение без проверки TLS

• URL: https://elastic.example.local:9200
• Пропустить проверку TLS: Игнорировать
• Индекс: logs-*
• Поле времени: @timestamp

Если адрес Elasticsearch указан без схемы, подключение будет выполняться по http. Для защищённого подключения рекомендуется указывать полный https:// URL сразу в явном виде.