健康报告 API

编辑

一个报告 Logstash 健康状态的 API。

curl -XGET 'localhost:9600/_health_report?pretty'

描述

编辑

健康 API 返回一个包含 Logstash 及其内部运行的管道的健康状态的报告。该报告包含构成 Logstash 功能的指标列表。

每个指标都有一个健康状态:绿色未知黄色红色。该指标将提供一个解释和元数据,描述其当前健康状态的原因。

顶级状态由最差的指标状态控制。

如果指标的状态为非绿色,则指标结果中可能会存在一个影响列表,其中详细说明了健康问题对功能产生的负面影响。每个影响都带有严重级别、受影响的系统区域以及对系统影响的简单描述。

一些健康指标可以确定健康问题的根本原因,并规定一组可以执行的步骤以改善系统健康状况。根本原因和修复步骤封装在 diagnosis 中。诊断包含一个描述根本原因分析的原因,一个包含解决问题步骤简要描述的操作,以及详细故障排除帮助的 URL。

健康指标对非绿色健康状态执行根本原因分析。频繁调用时,这可能需要大量的计算。

响应主体

编辑
status

(可选,字符串)基于所有指标的聚合状态,Logstash 的健康状态。状态为

绿色
Logstash 健康。
未知
无法确定 Logstash 的健康状况。
黄色
Logstash 的功能处于降级状态,可能需要修复以避免健康状况变为 红色
红色
Logstash 正在经历中断或某些功能不可用。
indicators

(对象)有关 Logstash 指标健康状况的信息。

indicators 的属性
<indicator>

(对象)包含指标的健康结果。

<indicator> 的属性
status

(字符串)指标的健康状态。状态为

绿色
指标健康。
未知
无法确定指标的健康状况。
黄色
指标的功能处于降级状态,可能需要修复以避免健康状况变为 红色
红色
指标正在经历中断或某些功能不可用。
symptom
(字符串)提供有关当前健康状态的信息的消息。
details
(可选,对象)一个包含有关导致当前健康状态结果的指标的附加信息的对象。每个指标都有一组独特的详细信息
impacts

(可选,数组)如果返回非健康状态,指标可能会包含此健康状态对 Logstash 产生的影响列表。

impacts 的属性
severity
(整数)此影响对 Logstash 功能的重要性。值为 1 表示最高严重程度,较大的值表示较低的严重程度。
description
(字符串)对 Logstash 的影响的描述。
impact_areas

(字符串数组)此影响影响的 Logstash 功能区域。可能的值为

  • pipeline_execution
diagnosis

(可选,数组)如果返回非健康状态,指标可能会包含一个诊断列表,该列表封装了健康问题的原因以及为解决该问题而采取的措施。

diagnosis 的属性
cause
(字符串)对此健康问题的根本原因的描述。
action
(字符串)应采取的解决问题的步骤的简要描述。 help_url 字段提供了更详细的分步指南来解决该问题。
help_url
(字符串)指向可解决健康问题的故障排除指南的链接。

指标详细信息

编辑

健康 API 中的每个健康指标都会返回一组详细信息,进一步解释系统的状态。这些详细信息具有每个指标独有的内容和结构。

管道指标详细信息

编辑
pipelines/indicators/<pipeline_id>/details

(对象)有关指定管道的信息。

pipelines/indicators/<pipeline_id>/details 的属性
status

(对象)与管道当前状态和运行状态相关的详细信息。

status 的属性
state
(字符串)管道的当前状态,包括它是 loadingrunningfinished 还是 terminated