« Logstash 监控故障排除 节点信息 API »
Elastic 文档 ›Logstash 参考 [8.16]

使用 API 监控 Logstash

编辑

使用 API 监控 Logstash

编辑

运行 Logstash 时，它会自动捕获运行时指标，您可以使用这些指标来监控 Logstash 部署的运行状况和性能。

Logstash 收集的指标包括：

  • Logstash 节点信息，例如管道设置、操作系统信息和 JVM 信息。
  • 插件信息，包括已安装插件的列表。
  • 节点统计信息，例如 JVM 统计信息、进程统计信息、与事件相关的统计信息和管道运行时统计信息。
  • 热点线程。

您可以使用 Logstash 提供的监控 API 来检索这些指标。这些 API 默认可用，无需任何额外配置。

或者，您可以配置 X-Pack 监控 将数据发送到监控集群。

监控是基础许可下的一个功能，因此免费使用。

用于监控 Logstash 的 API

编辑

Logstash 提供监控 API 用于检索有关 Logstash 的运行时信息。

您可以使用根资源检索有关 Logstash 实例的常规信息，包括主机和版本。

curl -XGET 'localhost:9600/?pretty'

示例响应

{
   "host": "skywalker",
   "version": "8.16.0",
   "http_address": "127.0.0.1:9600"
}

默认情况下，监控 API 尝试绑定到tcp:9600。如果此端口已被另一个 Logstash 实例使用，则需要使用指定的--api.http.port标志启动 Logstash 以绑定到不同的端口。有关更多信息，请参阅命令行标志。

保护 Logstash API

编辑

Logstash 监控 API 默认情况下不安全，但您可以通过多种方式配置 Logstash 来保护它们，以满足您组织的需求。

您可以通过在logstash.yml中设置api.ssl.enabled: true并提供相关的密钥库设置api.ssl.keystore.path和api.ssl.keystore.password来为 Logstash API 启用 SSL。

api.ssl.enabled: true
api.ssl.keystore.path: /path/to/keystore.jks
api.ssl.keystore.password: "s3cUr3p4$$w0rd"

密钥库必须为 jks 或 p12 格式，并且必须同时包含证书和私钥。连接的客户端会收到此证书，从而允许它们验证 Logstash 端点。

您还可以通过在logstash.yml中设置api.auth.type: basic并提供相关的凭据api.auth.basic.username和api.auth.basic.password来要求 HTTP 基本身份验证。

api.auth.type: basic
api.auth.basic.username: "logstash"
api.auth.basic.password: "s3cUreP4$$w0rD"

建议对密码类型字段使用密钥库或环境变量替换，以避免以纯文本形式存储它们。例如，指定值"${HTTP_PASS}"将解析为存储在安全密钥库的HTTP_PASS变量中的值（如果存在）或来自环境中的相同变量。

常用选项

编辑

以下选项可以应用于所有 Logstash 监控 API。

美观的输出结果
编辑

将?pretty=true附加到任何请求时，返回的 JSON 将采用美观的格式（仅用于调试！）。

人类可读的输出
编辑

对于 Logstash 8.16.0，热点线程 API 仅支持human选项。当您指定human=true时，结果将以纯文本格式而不是 JSON 格式返回。默认值为 false。

统计信息以适合人类（例如"exists_time": "1h"或"size": "1kb"）和计算机（例如"exists_time_in_millis": 3600000或"size_in_bytes": 1024）的格式返回。可以通过在查询字符串中添加?human=false来关闭人类可读的值。当统计结果被监控工具使用而不是用于人类阅读时，这样做是有意义的。human标志的默认值为false。

« Logstash 监控故障排除 节点信息 API »