Настройка мониторинга в Elasticsearch
Устарело в версии 7.16.
Использование плагина Elasticsearch Monitoring для сбора и отправки данных мониторинга устарело. Рекомендуемые методы сбора и отправки данных мониторинга в кластер мониторинга — Elastic Agent и Metricbeat. Если ранее вы настраивали методы сбора устаревшего типа, следует перейти к использованию Elastic Agent или Metricbeat.
По умолчанию возможности мониторинга Elasticsearch включены, но сбор данных отключен. Для включения сбора данных используйте настройку xpack.monitoring.collection.enabled.
За исключением случаев, указанных отдельно, эти настройки можно динамически обновлять в рабочем кластере с помощью API cluster-update-settings.
Чтобы настроить отображение данных мониторинга в интерфейсе мониторинга, настройте xpack.monitoring настройки в kibana.yml. Для управления тем, как данные мониторинга собираются из Logstash, настройте настройки мониторинга в logstash.yml.
Дополнительную информацию см. в разделе Мониторинг кластера.
Общие настройки мониторинга
-
xpack.monitoring.enabled - [7.8.0] Устарело в 7.8.0. Функции лицензии Basic всегда должны быть включены (Статические) Эта устаревшая настройка не имеет эффекта.
Настройки сбора мониторинга
Настройки xpack.monitoring.collection управляют тем, как данные собираются с ваших узлов Elasticsearch.
-
xpack.monitoring.collection.enabled - (Динамические) [7.16.0] Устарело в 7.16.0. Установите значение
true, чтобы включить сбор данных мониторинга. Когда это значениеfalse(по умолчанию), данные мониторинга Elasticsearch не собираются, и все данные мониторинга из других источников, таких как Kibana, Beats и Logstash, игнорируются.
-
xpack.monitoring.collection.interval -
[6.3.0] Устарело в 6.3.0. Используйте
xpack.monitoring.collection.enabledсо значениемfalseвместо него. (Динамические) Установка значения-1для отключения сбора данных больше не поддерживается начиная с 7.0.0.Управляет частотой сбора образцов данных. По умолчанию
10s. Если вы изменяете интервал сбора, установите значение параметраxpack.monitoring.min_interval_secondsвkibana.yml. -
xpack.monitoring.elasticsearch.collection.enabled - (Динамические) [7.16.0] Устарело в 7.16.0. Управляет тем, должны ли собираться статистические данные о вашем кластере Elasticsearch. По умолчанию
true. Это отличается отxpack.monitoring.collection.enabled, которое позволяет включить или отключить весь сбор данных мониторинга. Однако эта настройка просто отключает сбор данных Elasticsearch, но при этом позволяет проходить через этот кластер другим данным (например, данные мониторинга Kibana, Logstash, Beats или APM Server). -
xpack.monitoring.collection.cluster.stats.timeout - (Динамические) [7.16.0] Устарело в 7.16.0. Тайм-аут для сбора статистики кластера в единицах времени. По умолчанию
10s. -
xpack.monitoring.collection.node.stats.timeout - (Динамические) [7.16.0] Устарело в 7.16.0. Тайм-аут для сбора статистики узла в единицах времени. По умолчанию
10s. -
xpack.monitoring.collection.indices - (Динамические) [7.16.0] Устарело в 7.16.0. Управляет индексами, из которых функции мониторинга собирают данные. По умолчанию все индексы. Укажите имена индексов через запятую, например
test1,test2,test3. Имена могут включать подстановочные знаки, напримерtest*. Вы можете явно исключить индексы, добавив-. Например,test*,-test3будет отслеживать все индексы, начинающиеся сtest, за исключениемtest3. Системные индексы, такие как .security* или .kibana*, всегда начинаются с.и, как правило, должны отслеживаться. Рассмотрите добавление.*в список индексов, чтобы обеспечить мониторинг системных индексов. Например:.*,test*,-test3 -
xpack.monitoring.collection.index.stats.timeout - (Динамические) [7.16.0] Устарело в 7.16.0. Тайм-аут для сбора статистики индексов в единицах времени. По умолчанию
10s. -
xpack.monitoring.collection.index.recovery.active_only - (Динамические) [7.16.0] Устарело в 7.16.0. Управляет тем, собираются ли все восстановления. Установите значение
true, чтобы собирать только активные восстановления. По умолчаниюfalse. -
xpack.monitoring.collection.index.recovery.timeout - (Динамические) [7.16.0] Устарело в 7.16.0. Тайм-аут для сбора информации о восстановлении в единицах времени. По умолчанию
10s.
-
xpack.monitoring.history.duration -
(Динамические) [7.16.0] Устарело в 7.16.0. Длительность хранения индексов, созданных экспортером мониторинга, после которой они автоматически удаляются, в единицах времени. По умолчанию
7d(7 дней).Это значение имеет минимальное значение
1d(1 день), чтобы обеспечить отслеживание чего-либо, и его нельзя отключить.Эта настройка в настоящее время влияет только на экспортеры типа
local. Индексы, созданные с помощью экспортераhttp, не удаляются автоматически.
-
xpack.monitoring.exporters - (Статические) Настраивает место, где агент хранит данные мониторинга. По умолчанию агент использует локальный экспортер, который индексирует данные мониторинга в кластере, где он установлен. Используйте HTTP-экспортер для отправки данных в отдельный кластер мониторинга. Дополнительную информацию см. в разделах Настройки локального экспортера, Настройки HTTP-экспортера и Как это работает.
Настройки локального экспортера
Экспортер local по умолчанию используется функциями мониторинга. Как следует из названия, он экспортирует данные в локальный кластер, что означает, что для этого не требуется много настроек.
Если вы не укажете никаких экспортеров, функции мониторинга автоматически создадут один для вас. Если любой экспортер указан, то никакой по умолчанию не добавляется.
xpack.monitoring.exporters.my_local: type: local
-
type - [7.16.0] Устарело в 7.16.0. Значение для экспортера Local всегда должно быть
local, и оно обязательно. -
use_ingest - Нужно ли предоставлять заглушку-пайплайн кластеру и процессор пайплайнов с каждым запросом по массе. Значение по умолчанию —
true. Если отключено, значит пайплайны не будут использоваться, что означает, что будущие релизы не смогут автоматически модернизировать запросы по массе, чтобы сделать их совместимыми с будущими версиями. -
cluster_alerts.management.enabled - [7.16.0] Устарело в 7.16.0. Нужно ли создавать кластерные оповещения для этого кластера. Значение по умолчанию —
true. Для использования этой функции Watcher должен быть включен. При базовой лицензии кластерные оповещения не отображаются. -
wait_master.timeout - [7.16.0] Устарело в 7.16.0. Время ожидания мастера для настройки экспортера
localдля мониторинга в единицах времени. По истечении этого периода не-мастер узлы предупреждают пользователя о возможной отсутствующей конфигурации. По умолчанию30s.
Настройки экспортера HTTP
В следующих списках показаны параметры, которые можно указать с помощью экспортера http. Все параметры показаны, как следует после выбранного вами имени экспортера:
xpack.monitoring.exporters.my_remote: type: http host: ["host:port", ...]
-
type - [7.16.0] Устарело в 7.16.0. Значение для экспортера HTTP всегда должно быть
http, и оно обязательно. -
host -
[7.16.0] Устарело в 7.16.0. Хост поддерживает несколько форматов, как массив, так и одно значение. Поддерживаемые форматы включают
hostname,hostname:port,http://hostnamehttp://hostname:port,https://hostnameиhttps://hostname:port. Хосты не предполагаются. Схема по умолчанию всегдаhttp, а порт по умолчанию всегда9200, если он не указан в строкеhost.xpack.monitoring.exporters: example1: type: http host: "10.1.2.3" example2: type: http host: ["http://10.1.2.4"] example3: type: http host: ["10.1.2.5", "10.1.2.6"] example4: type: http host: ["https://10.1.2.3:9200"] -
auth.username - [7.16.0] Устарело в 7.16.0. Имя пользователя обязательно, если указан
auth.secure_password. -
auth.secure_password - (Безопасные, перезагружаемые) [7.16.0] Устарело в 7.16.0. Пароль для
auth.username. -
connection.timeout - [7.16.0] Устарело в 7.16.0. Время ожидания подключения HTTP для открытия сокета для запроса, в единицах времени. Значение по умолчанию —
6s. -
connection.read_timeout - [7.16.0] Устарело в 7.16.0. Время ожидания HTTP-соединения для получения ответа сокета, в единицах времени. Значение по умолчанию —
10 * connection.timeout(60sесли ни одно из них не задано). -
ssl - [7.16.0] Устарело в 7.16.0. Каждый экспортер HTTP может определить свои собственные настройки TLS/SSL или унаследовать их. См. Настройки TLS/SSL мониторинга X-Pack.
-
proxy.base_path - [7.16.0] Устарело в 7.16.0. Базовый путь для префикса всех исходящих запросов, например,
/base/path(например, запросы по массе будут отправляться как/base/path/_bulk). Значения по умолчанию нет. -
headers -
[7.16.0] Устарело в 7.16.0. Дополнительные заголовки, которые добавляются к каждому запросу, что может помочь при маршрутизации запросов через прокси.
xpack.monitoring.exporters.my_remote: headers: X-My-Array: [abc, def, xyz] X-My-Header: abc123Заголовки, основанные на массивах, отправляются
nраз, гдеn— размер массива.Content-TypeиContent-Lengthнельзя установить. Любые заголовки, созданные агентом мониторинга, переопределят все определённые здесь. -
index.name.time_format - [7.16.0] Устарело в 7.16.0. Механизм изменения суффикса даты по умолчанию для ежедневных индексов мониторинга. Формат по умолчанию —
yyyy.MM.dd. Например,.monitoring-es-7-2021.08.26. -
use_ingest - Нужно ли предоставлять заглушку-пайплайн кластеру мониторинга и процессор пайплайнов с каждым запросом по массе. Значение по умолчанию —
true. Если отключено, значит пайплайны не будут использоваться, что означает, что будущие релизы не смогут автоматически модернизировать запросы по массе, чтобы сделать их совместимыми с будущими версиями. -
cluster_alerts.management.enabled - [7.16.0] Устарело в 7.16.0. Нужно ли создавать кластерные оповещения для этого кластера. Значение по умолчанию —
true. Для использования этой функции Watcher должен быть включен. При базовой лицензии кластерные оповещения не отображаются. -
cluster_alerts.management.blacklist -
[7.16.0] Устарело в 7.16.0. Запрещает создание определённых кластерных оповещений. Также удаляет все применимые ватчи, которые уже существуют в текущем кластере.
Вы можете добавить любой из следующих идентификаторов ватча в список заблокированных оповещений:
-
elasticsearch_cluster_status -
elasticsearch_version_mismatch -
elasticsearch_nodes -
kibana_version_mismatch -
logstash_version_mismatch -
xpack_license_expiration
Например:
["elasticsearch_version_mismatch","xpack_license_expiration"]. -
Мониторинг настроек TLS/SSL X-Pack
Вы можете настроить следующие параметры TLS/SSL.
-
xpack.monitoring.exporters.$NAME.ssl.supported_protocols -
(Статический) [7.16.0] Устарело в 7.16.0. Поддерживаемые протоколы с версиями. Допустимые протоколы:
SSLv2Hello,SSLv3,TLSv1,TLSv1.1,TLSv1.2,TLSv1.3. Если поставщик SSL JVM поддерживает TLSv1.3, значение по умолчанию —TLSv1.3,TLSv1.2,TLSv1.1. В противном случае значение по умолчанию —TLSv1.2,TLSv1.1.Elasticsearch полагается на реализацию SSL и TLS вашей JDK. Для получения дополнительной информации см. Поддерживаемые версии SSL/TLS по версиям JDK.
Если
xpack.security.fips_mode.enabledявляетсяtrue, вы не можете использоватьSSLv2HelloилиSSLv3. См. FIPS 140-2. -
xpack.monitoring.exporters.$NAME.ssl.verification_mode -
(Статический) [7.16.0] Устарело в 7.16.0. Управляет проверкой сертификатов.
Допустимые значения
-
full - Проверяет, что предоставленный сертификат: имеет дату выдачи, которая находится в диапазоне между
not_beforeиnot_after; связан с доверенным центром сертификации (ЦС); имеетhostnameили IP-адрес, соответствующий именам в сертификате. -
certificate - Проверяет предоставленный сертификат и подтверждает, что он подписан доверенным органом (ЦС), но не проверяет
hostnameсертификата. -
none -
Не выполняет проверку сертификата.
Установка проверки сертификатов на
noneотключает многие преимущества безопасности SSL/TLS, что очень опасно. Устанавливайте это значение только по указанию службы поддержки Elastic в качестве временного диагностического механизма при попытке устранения ошибок TLS.
Значение по умолчанию —
full. -
-
xpack.monitoring.exporters.$NAME.ssl.cipher_suites -
(Статический) [7.16.0] Устарело в 7.16.0. Поддерживаемые наборы шифров зависят от используемой версии Java. Например, для версии 12 значение по умолчанию —
TLS_AES_256_GCM_SHA384,TLS_AES_128_GCM_SHA256,TLS_CHACHA20_POLY1305_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384,TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256,TLS_ECDHE_ECDSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256,TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA,TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA,TLS_RSA_WITH_AES_256_GCM_SHA384,TLS_RSA_WITH_AES_128_GCM_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA256,TLS_RSA_WITH_AES_128_CBC_SHA256,TLS_RSA_WITH_AES_256_CBC_SHA,TLS_RSA_WITH_AES_128_CBC_SHA.Для получения дополнительной информации см. документацию Java Cryptography Architecture от Oracle.
Настройки ключей и доверенных сертификатов TLS/SSL X-Pack мониторинга
Следующие настройки используются для указания закрытого ключа, сертификата и доверенных сертификатов, которые должны использоваться при общении по SSL/TLS-соединению. Закрытый ключ и сертификат необязательны и используются, если сервер требует проверки клиента для аутентификации PKI.
Файлы в формате PEM
При использовании файлов в формате PEM используйте следующие настройки:
-
xpack.monitoring.exporters.$NAME.ssl.key -
(Статический) [7.16.0] Устарело в 7.16.0. Путь к файлу PEM, содержащему закрытый ключ.
Используется, если требуется аутентификация клиента HTTP. Вы не можете использовать эту настройку и
ssl.keystore.pathодновременно. -
xpack.monitoring.exporters.$NAME.ssl.key_passphrase -
(Статический) [7.16.0] Устарело в 7.16.0. Пароль, используемый для расшифровки закрытого ключа. Поскольку ключ может быть не зашифрован, это значение необязательно. [7.17.0] Устарело в 7.17.0. Предпочтительнее использовать
ssl.secure_key_passphrase.Вы не можете использовать эту настройку и
ssl.secure_key_passphraseодновременно. -
xpack.monitoring.exporters.$NAME.ssl.secure_key_passphrase - (Безопасные) [7.16.0] Устарело в 7.16.0. Пароль, используемый для расшифровки закрытого ключа. Поскольку ключ может быть не зашифрован, это значение необязательно.
-
xpack.monitoring.exporters.$NAME.ssl.certificate -
(Статический) [7.16.0] Устарело в 7.16.0. Указывает путь к файлу PEM с сертификатом (или цепочкой сертификатов), связанным с ключом.
Эта настройка может быть использована только если установлена настройка
ssl.key. -
xpack.monitoring.exporters.$NAME.ssl.certificate_authorities -
(Статический) [7.16.0] Устарело в 7.16.0. Список путей к файлам PEM с сертификатами, которым следует доверять.
Эта настройка и
ssl.truststore.pathне могут быть использованы одновременно.
Файлы хранилища ключей Java
При использовании файлов хранилища ключей Java (JKS), содержащих закрытый ключ, сертификат и доверенные сертификаты, используйте следующие параметры:
-
xpack.monitoring.exporters.$NAME.ssl.keystore.path -
(Статический) [7.16.0] Устарело в 7.16.0. Путь к файлу хранилища ключей, содержащему закрытый ключ и сертификат.
Он должен быть файлом хранилища ключей Java (jks) или файлом PKCS#12. Вы не можете использовать этот параметр и
ssl.keyодновременно. -
xpack.monitoring.exporters.$NAME.ssl.keystore.password - (Статический) Пароль хранилища ключей. [7.17.0] Устарело в 7.17.0. Предпочтительно использовать
ssl.keystore.secure_password. -
xpack.monitoring.exporters.$NAME.ssl.keystore.secure_password - (Безопасный) [7.16.0] Устарело в 7.16.0. Пароль хранилища ключей.
-
xpack.monitoring.exporters.$NAME.ssl.keystore.key_password -
(Статический) Пароль ключа в хранилище ключей. По умолчанию используется пароль хранилища ключей. [7.17.0] Устарело в 7.17.0. Предпочтительно использовать
ssl.keystore.secure_key_password.Вы не можете использовать этот параметр и
ssl.keystore.secure_passwordодновременно. -
xpack.monitoring.exporters.$NAME.ssl.keystore.secure_key_password - (Безопасный) [7.16.0] Устарело в 7.16.0. Пароль ключа в хранилище ключей. По умолчанию используется пароль хранилища ключей.
-
xpack.monitoring.exporters.$NAME.ssl.truststore.path -
(Статический) [7.16.0] Устарело в 7.16.0. Путь к хранилищу ключей, содержащему доверенные сертификаты. Он должен быть файлом хранилища ключей Java (jks) или файлом PKCS#12.
Вы не можете использовать этот параметр и
ssl.certificate_authoritiesодновременно. -
xpack.monitoring.exporters.$NAME.ssl.truststore.password -
(Статический) Пароль хранилища доверенных сертификатов. [7.17.0] Устарело в 7.17.0. Предпочтительно использовать
ssl.truststore.secure_password.Вы не можете использовать этот параметр и
ssl.truststore.secure_passwordодновременно. -
xpack.monitoring.exporters.$NAME.ssl.truststore.secure_password - (Безопасный) [7.16.0] Устарело в 7.16.0. Пароль хранилища доверенных сертификатов.
Файлы PKCS#12
Elasticsearch можно настроить на использование файлов контейнеров PKCS#12 (.p12 или .pfx), содержащих закрытый ключ, сертификат и доверенные сертификаты.
Файлы PKCS#12 настраиваются так же, как и файлы хранилища ключей Java:
-
xpack.monitoring.exporters.$NAME.ssl.keystore.path -
(Статический) [7.16.0] Устарело в 7.16.0. Путь к файлу хранилища ключей, содержащему закрытый ключ и сертификат.
Он должен быть файлом хранилища ключей Java (jks) или файлом PKCS#12. Вы не можете использовать этот параметр и
ssl.keyодновременно. -
xpack.monitoring.exporters.$NAME.ssl.keystore.type - (Статический) [7.16.0] Устарело в 7.16.0. Формат файла хранилища ключей. Он должен быть либо
jks, либоPKCS12. Если путь к хранилищу ключей оканчивается на ".p12", ".pfx" или ".pkcs12", этот параметр по умолчанию равенPKCS12. В противном случае по умолчанию используетсяjks. -
xpack.monitoring.exporters.$NAME.ssl.keystore.password - (Статический) [7.16.0] Устарело в 7.16.0. Пароль хранилища ключей. [7.17.0] Устарело в 7.17.0. Предпочтительно использовать
ssl.keystore.secure_password. -
xpack.monitoring.exporters.$NAME.ssl.keystore.secure_password - (Безопасный) [7.16.0] Устарело в 7.16.0. Пароль хранилища ключей.
-
xpack.monitoring.exporters.$NAME.ssl.keystore.key_password -
(Статический) Пароль ключа в хранилище ключей. По умолчанию используется пароль хранилища ключей. [7.17.0] Устарело в 7.17.0. Предпочтительно использовать
ssl.keystore.secure_key_password.Вы не можете использовать этот параметр и
ssl.keystore.secure_passwordодновременно. -
xpack.monitoring.exporters.$NAME.ssl.keystore.secure_key_password - (Безопасный) [7.16.0] Устарело в 7.16.0. Пароль ключа в хранилище ключей. По умолчанию используется пароль хранилища ключей.
-
xpack.monitoring.exporters.$NAME.ssl.truststore.path -
(Статический) [7.16.0] Устарело в 7.16.0. Путь к хранилищу ключей, содержащему доверенные сертификаты. Он должен быть файлом хранилища ключей Java (jks) или файлом PKCS#12.
Вы не можете использовать этот параметр и
ssl.certificate_authoritiesодновременно. -
xpack.monitoring.exporters.$NAME.ssl.truststore.type - (Статический) [7.16.0] Устарело в 7.16.0. Установите это в значение
PKCS12, чтобы указать, что хранилище доверенных сертификатов является файлом PKCS#12. -
xpack.monitoring.exporters.$NAME.ssl.truststore.password -
(Статический) [7.16.0] Устарело в 7.16.0. Пароль хранилища доверенных сертификатов. [7.17.0] Устарело в 7.17.0. Предпочтительно использовать
ssl.truststore.secure_password.Вы не можете использовать этот параметр и
ssl.truststore.secure_passwordодновременно. -
xpack.monitoring.exporters.$NAME.ssl.truststore.secure_password - (Безопасный) [7.16.0] Устарело в 7.16.0. Пароль хранилища доверенных сертификатов.
© 2023-2025 Elasticsearch
As of September 2024, Elasticsearch is available under a choice of three licenses: the Server Side Public License (SSPL), the Elastic License, or the AGPLv3 (OSI approved).
Elasticsearch and the Elasticsearch logo are trademarks of Elasticsearch B.V., registered in the U.S. and in other countries.
https://www.elastic.co/guide/en/elasticsearch/reference/8.17/monitoring-settings.html