API состояния

GET /_health_report

GET /_health_report/<indicator>

API состояния возвращает отчет о состоянии кластера Elasticsearch. Отчет содержит список показателей, составляющих функциональность Elasticsearch.

Каждый показатель имеет состояние: green, unknown, yellow или red. Показатель предоставит объяснение и метаданные, описывающие причину его текущего состояния.

Состояние кластера контролируется наихудшим состоянием показателя.

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

Некоторые показатели состояния могут определить первопричину проблемы состояния и предложить набор шагов, которые можно выполнить для улучшения состояния системы. Первопричина и шаги по устранению неполадок заключены в diagnosis. Диагностика содержит причину, описывающую анализ первопричины, действие, содержащее краткое описание шагов по устранению проблемы, список затронутых ресурсов (при необходимости) и пошаговое руководство по устранению неполадок для решения диагностированной проблемы.

resp = client.health_report()
print(resp)

response = client.health_report
puts response

const response = await client.healthReport();
console.log(response);

GET _health_report

API возвращает ответ со всеми индикаторами независимо от текущего состояния.

resp = client.health_report(
    feature="shards_availability",
)
print(resp)

response = client.health_report(
  feature: 'shards_availability'
)
puts response

const response = await client.healthReport({
  feature: "shards_availability",
});
console.log(response);

GET _health_report/shards_availability

API возвращает ответ только для индикатора доступности фрагментов.

resp = client.health_report(
    verbose=False,
)
print(resp)

response = client.health_report(
  verbose: false
)
puts response

const response = await client.healthReport({
  verbose: "false",
});
console.log(response);

GET _health_report?verbose=false

API возвращает ответ со всеми индикаторами состояния, но не будет рассчитывать детали или анализ причин неполадок в ответе. Это полезно, если вы хотите отслеживать API состояния и не хотите, чтобы каждый вызов накладывал издержки на расчет дополнительных деталей по устранению неполадок.