Ведение журнала

Вы можете использовать системные журналы Elasticsearch для мониторинга кластера и диагностики проблем. Если Elasticsearch запущен как служба, расположение журналов по умолчанию зависит от вашей платформы и метода установки:

Если вы запускаете Elasticsearch из командной строки, Elasticsearch выводит журналы в стандартный вывод (stdout).

Elasticsearch использует Log4j 2 для ведения журналов. Log4j 2 можно настроить с помощью файла log4j2.properties. Elasticsearch предоставляет три свойства, ${sys:es.logs.base_path}, ${sys:es.logs.cluster_name} и ${sys:es.logs.node_name}, которые можно использовать в файле конфигурации для определения расположения файлов журналов. Свойство ${sys:es.logs.base_path} будет соответствовать каталогу журналов, ${sys:es.logs.cluster_name} будет соответствовать имени кластера (используется в качестве префикса имён файлов журналов в конфигурации по умолчанию), а ${sys:es.logs.node_name} будет соответствовать имени узла (если имя узла явно задано).

Например, если ваш каталог журналов (path.logs) - это /var/log/elasticsearch, а ваш кластер называется production, то ${sys:es.logs.base_path} будет соответствовать /var/log/elasticsearch, а ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}.log будет соответствовать /var/log/elasticsearch/production.log.

######## Server JSON ############################
appender.rolling.type = RollingFile 
appender.rolling.name = rolling
appender.rolling.fileName = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_server.json 
appender.rolling.layout.type = ESJsonLayout 
appender.rolling.layout.type_name = server 
appender.rolling.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}-%d{yyyy-MM-dd}-%i.json.gz 
appender.rolling.policies.type = Policies
appender.rolling.policies.time.type = TimeBasedTriggeringPolicy 
appender.rolling.policies.time.interval = 1 
appender.rolling.policies.time.modulate = true 
appender.rolling.policies.size.type = SizeBasedTriggeringPolicy 
appender.rolling.policies.size.size = 256MB 
appender.rolling.strategy.type = DefaultRolloverStrategy
appender.rolling.strategy.fileIndex = nomax
appender.rolling.strategy.action.type = Delete 
appender.rolling.strategy.action.basepath = ${sys:es.logs.base_path}
appender.rolling.strategy.action.condition.type = IfFileName 
appender.rolling.strategy.action.condition.glob = ${sys:es.logs.cluster_name}-* 
appender.rolling.strategy.action.condition.nested_condition.type = IfAccumulatedFileSize 
appender.rolling.strategy.action.condition.nested_condition.exceeds = 2GB 
################################################

######## Server -  old style pattern ###########
appender.rolling_old.type = RollingFile
appender.rolling_old.name = rolling_old
appender.rolling_old.fileName = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_server.log 
appender.rolling_old.layout.type = PatternLayout
appender.rolling_old.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] [%node_name]%marker %m%n
appender.rolling_old.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}-%d{yyyy-MM-dd}-%i.old_log.gz

Обратите внимание, что вы можете заменить .gz на .zip в appender.rolling.filePattern для сжатия архивированных журналов в формате zip. Если вы удалите расширение .gz, то журналы не будут сжиматься при архивировании.

Если вы хотите сохранить файлы журналов в течение определенного периода времени, вы можете использовать стратегию архивирования с действием удаления.

appender.rolling.strategy.type = DefaultRolloverStrategy 
appender.rolling.strategy.action.type = Delete 
appender.rolling.strategy.action.basepath = ${sys:es.logs.base_path} 
appender.rolling.strategy.action.condition.type = IfFileName 
appender.rolling.strategy.action.condition.glob = ${sys:es.logs.cluster_name}-* 
appender.rolling.strategy.action.condition.nested_condition.type = IfLastModified 
appender.rolling.strategy.action.condition.nested_condition.age = 7D 

Можно загрузить несколько файлов конфигурации (в этом случае они будут объединены), если они названы log4j2.properties и имеют каталог конфигурации Elasticsearch в качестве предка; это полезно для плагинов, которые предоставляют дополнительные логгеры. Раздел logger содержит пакеты java и их соответствующий уровень ведения журнала. Раздел appender содержит пункты назначения для журналов. Подробная информация о том, как настроить ведение журнала и все поддерживаемые аппендеры, доступна в документации Log4j.

Каждый пакет Java в исходном коде Elasticsearch имеет соответствующий логгер. Например, пакет org.elasticsearch.discovery содержит logger.org.elasticsearch.discovery для журналов, связанных с процессом дискoвери.

Чтобы получить более или менее подробные журналы, используйте API настроек обновления кластера, чтобы изменить уровень журналов соответствующего регистратора. Каждый регистратор принимает встроенные в Log4j 2 уровни журналов, от наименее до наиболее подробных: OFF, FATAL, ERROR, WARN, INFO, DEBUG и TRACE. По умолчанию уровень журнала равен INFO. Сообщения, записанные на более высоких уровнях подробности (DEBUG и TRACE), предназначены только для опытных пользователей.

PUT /_cluster/settings
{
  "persistent": {
    "logger.org.elasticsearch.discovery": "DEBUG"
  }
}

Другие способы изменения уровней журналов:

Elasticsearch также записывает журналы устаревания в директорию журналов. Эти журналы записывают сообщение, когда вы используете устаревшую функциональность Elasticsearch. Вы можете использовать журналы устаревания для обновления своего приложения перед обновлением Elasticsearch до новой основной версии.

По умолчанию Elasticsearch выполняет сворачивание и сжатие журналов устаревания при достижении 1 ГБ. По умолчанию сохраняется максимум пять файлов журналов: четыре свернутых журнала и активный журнал.

Elasticsearch выводит сообщения журналов устаревания на уровне CRITICAL. Эти сообщения указывают, что используемая устаревшая функция будет удалена в следующей основной версии. Сообщения журналов устаревания на уровне WARN указывают, что была использована менее критическая функция, она не будет удалена в следующей основной версии, но может быть удалена в будущем.

Чтобы прекратить запись сообщений журналов устаревания, установите logger.deprecation.level на OFF в log4j2.properties:

logger.deprecation.level = OFF

В качестве альтернативы можно динамически изменить уровень ведения журнала:

PUT /_cluster/settings
{
  "persistent": {
    "logger.org.elasticsearch.deprecation": "OFF"
  }
}

Обратитесь к Настройка уровней ведения журнала.

Вы можете определить, что вызывает устаревшую функциональность, если X-Opaque-Id использовался в качестве HTTP-заголовка. Идентификатор пользователя включен в поле X-Opaque-ID в JSON-журналах устаревания.

{
  "type": "deprecation",
  "timestamp": "2019-08-30T12:07:07,126+02:00",
  "level": "WARN",
  "component": "o.e.d.r.a.a.i.RestCreateIndexAction",
  "cluster.name": "distribution_run",
  "node.name": "node-0",
  "message": "[types removal] Using include_type_name in create index requests is deprecated. The parameter will be removed in the next major version.",
  "x-opaque-id": "MY_USER_ID",
  "cluster.uuid": "Aq-c-PAeQiK3tfBYtig9Bw",
  "node.id": "D7fUYfnfTLa2D7y-xw6tZg"
}

Журналы устаревания могут быть индексированы в .logs-deprecation.elasticsearch-default поток данных cluster.deprecation_indexing.enabled значение настроено на true.

appender.rolling.layout.type = ESJsonLayout
appender.rolling.layout.type_name = server

appender.rolling.type = RollingFile
appender.rolling.name = rolling
appender.rolling.fileName = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}_server.log
appender.rolling.layout.type = PatternLayout
appender.rolling.layout.pattern = [%d{ISO8601}][%-5p][%-25c{1.}] [%node_name]%marker %.-10000m%n
appender.rolling.filePattern = ${sys:es.logs.base_path}${sys:file.separator}${sys:es.logs.cluster_name}-%d{yyyy-MM-dd}-%i.log.gz