健康报告 API

编辑

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

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

描述

编辑

健康 API 返回一份报告,其中包含 Logstash 的健康状态以及在其内部运行的管道。该报告包含构成 Logstash 功能的一系列指标。

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

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

如果指标的状态不是绿色,则指标结果中可能存在一系列影响,详细说明健康问题对功能造成的不利影响。每个影响都带有严重级别、受影响的系统区域以及对系统影响的简单描述。

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

健康指标执行非绿色健康状态的根本原因分析。如果频繁调用,这在计算上可能很昂贵。

响应主体

编辑
状态

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

绿色
Logstash 运行健康。
未知
无法确定 Logstash 的健康状况。
黄色
Logstash 的功能处于降级状态,可能需要进行修复以避免健康状况变为红色
红色
Logstash 出现故障或某些功能不可用。
指标

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

属性 指标
<指标>

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

属性 <指标>
状态

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

绿色
指标运行健康。
未知
无法确定指标的健康状况。
黄色
指标的功能处于降级状态,可能需要进行修复以避免健康状况变为红色
红色
指标出现故障或某些功能不可用。
症状
(字符串) 提供有关当前健康状态的信息的消息。
详细信息
(可选,对象) 包含有关导致当前健康状态结果的指标的其他信息的特定对象。每个指标都有一组唯一的详细信息
影响

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

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

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

  • 管道执行
诊断

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

属性 诊断
原因
(字符串) 此健康问题的根本原因的描述。
操作
(字符串) 应采取的解决问题的步骤的简要说明。help_url 字段提供了更详细的分步指南来解决问题。
帮助 URL
(字符串) 到故障排除指南的链接,该指南将解决健康问题。

指标详细信息

编辑

健康 API 中的每个健康指标都返回一组详细信息,以进一步解释系统状态。详细信息的内容和结构对于每个指标都是唯一的。

管道指标详细信息

编辑
管道/指标/<管道 ID>/详细信息

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

属性 管道/指标/<管道 ID>/详细信息
状态

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

属性 状态
状态
(字符串) 管道的当前状态,包括它是否处于加载运行完成终止状态。