leroymerlinbr/logstash-exporter

logstash-exporter

镜像概述与主要用途

logstash-exporter是一款用于将Logstash指标导出到Prometheus的工具，旨在实现对Logstash运行状态、性能及事件处理情况的全面监控。通过采集Logstash的JVM、内存、GC、管道、插件等多维度指标，为Prometheus提供标准化的监控数据。

版本兼容性与重要信息

支持版本

仅支持Logstash >= v7.3，早期版本请参考https://github.com/sequra/logstash_exporter%E3%80%82

项目背景

本项目基于多个分支开发，主要原因包括：

• https://github.com/sequra/logstash_exporter%E7%BB%B4%E6%8A%A4%E4%B8%8D%E5%86%8D%E6%B4%BB%E8%B7%83%EF%BC%9B
• 自建二进制和Docker镜像，避免依赖第三方项目（如https://github.com/bitnami/bitnami-docker-logstash-exporter%EF%BC%89%E4%BB%8E%E5%A4%96%E9%83%A8%E6%9C%8D%E5%8A%A1%E5%99%A8%E4%B8%8B%E8%BD%BD%E4%BA%8C%E8%BF%9B%E5%88%B6%E6%96%87%E4%BB%B6%E7%9A%84%E9%A3%8E%E9%99%A9%EF%BC%9B
• 支持多架构（如arm64），满足在Graviton节点上运行Logstash的需求。

核心功能与特性

• 多维度指标采集：涵盖Logstash的JVM状态、内存使用、GC情况、管道事件、插件性能等指标；
• Prometheus兼容：提供Prometheus标准格式的指标接口，便于集成到监控系统；
• 灵活配置：支持自定义Logstash指标API端点和监听地址；
• 多架构支持：适配amd64、arm64等架构，适应不同运行环境。

使用场景与适用范围

适用于需要对Logstash进行监控的场景，特别是：

• 使用Prometheus作为监控系统的环境；
• 运行Logstash >= v7.3的实例；
• 需要在多架构环境（如arm64/Graviton节点）部署的场景；
• 需要监控Logstash性能、资源使用和事件处理情况的用户。

使用方法与配置说明

Docker部署

使用预构建的Docker镜像直接运行：

sh
docker run leroymerlinbr/logstash_exporter:latest

命令行参数

通过命令行参数配置exporter，支持的参数如下：

sh
logstash_exporter <flags>
  -h, --help                    显示上下文相关帮助（也可尝试 --help-long 和 --help-man）。
      --logstash.endpoint="http://localhost:9600"  
                                Logstash指标API的协议、主机和端口。
      --listen.address=":9198"  暴露指标和Web界面的地址。
      --log.level="info"        定义日志级别。
      --version                 显示应用版本。

指标说明

以下是exporter采集的主要指标列表：

贡献

我们欢迎任何形式的贡献。建议使用符合Conventional Commits规范的Git提交信息。

请查看https://github.com/leroy-merlin-br/logstash-exporter/issues%E9%A1%B5%E9%9D%A2%E4%BA%86%E8%A7%A3%E9%9C%80%E8%A6%81%E5%BC%80%E5%8F%91%E7%9A%84%E5%8A%9F%E8%83%BD%E5%92%8C%E4%BF%AE%E5%A4%8D%E7%9A%84bug%E3%80%82

集成测试

为了手动执行集成测试（确保特定Logstash版本与logstash-exporter兼容），可参考此处的说明。