scrapinghub/jmx_exporter

JMX Exporter

镜像概述和主要用途

JMX Exporter是一款将JMX指标转换为Prometheus可采集格式的工具，能够配置化地抓取并暴露JMX目标的mBeans。该工具主要设计为Java Agent运行，通过HTTP服务器暴露本地JVM的指标；也可作为独立HTTP服务器抓取远程JMX目标，但存在配置复杂、无法暴露进程指标（如内存和CPU使用）等缺点，因此强烈推荐以Java Agent方式运行。

核心功能和特性

• 多运行模式：支持作为Java Agent（推荐）或独立HTTP服务器运行
• 灵活配置：通过YAML配置文件定义指标采集规则、过滤条件等
• 指标转换：支持自定义指标名称、标签、类型及值处理（如单位转换）
• 安全支持：支持远程JMX的密码认证及SSL连接配置
• 默认格式：提供默认指标命名格式，适用于大多数场景

使用场景和适用范围

适用于需要监控Java应用JVM状态及应用自定义JMX指标的场景，如：

• 微服务应用的JVM性能监控（内存、GC、线程等）
• 基于JMX暴露指标的中间件监控（如Cassandra、Kafka等）
• 需要将JMX指标接入Prometheus监控体系的场景

使用方法和配置说明

运行方式

1. 作为Java Agent运行

1. 下载JAR包：jmx_prometheus_javaagent-0.12.0.jar
2. 运行命令：

bash
java -javaagent:./jmx_prometheus_javaagent-0.12.0.jar=8080:config.yaml -jar yourJar.jar

• 指标可通过 http://localhost:8080/metrics 访问
• 如需绑定特定IP，将端口部分改为 host:port（如 192.168.1.100:8080:config.yaml）

2. 作为Docker容器运行

bash
docker run -v /path/to/config.yml:/etc/jmx_exporter/config.yml:ro scrapinghub/jmx_exporter:latest

构建

执行 mvn package 命令构建项目。

配置说明

配置文件采用YAML格式，以下是包含所有可能选项的示例：

yaml
---
startDelaySeconds: 0
hostPort: 127.0.0.1:1234
username: 
password: 
jmxUrl: service:jmx:rmi:///jndi/rmi://127.0.0.1:1234/jmxrmi
ssl: false
lowercaseOutputName: false
lowercaseOutputLabelNames: false
whitelistObjectNames: ["org.apache.cassandra.metrics:*"]
blacklistObjectNames: ["org.apache.cassandra.metrics:type=ColumnFamily,*"]
rules:
  - pattern: 'org.apache.cassandra.metrics<type=(\w+), name=(\w+)><>Value: (\d+)'
    name: cassandra_$1_$2
    value: $3
    valueFactor: 0.001
    labels: {}
    help: "Cassandra metric $1 $2"
    type: GAUGE
    attrNameSnakeCase: false

配置参数说明

指标名和标签名将被 sanitize 处理：除[a-zA-Z0-9:_]外的字符替换为下划线，相邻下划线会被合并；标签值和帮助文本无限制。

最小配置

{}（空配置）将连接本地JVM并以默认格式采集所有指标。注意：即使指标未导出，scraper仍会处理所有mBeans。

模式输入格式

pattern匹配的输入格式为：

domain<beanpropertyName1=beanPropertyValue1, beanpropertyName2=beanPropertyValue2, ...><key1, key2, ...>attrName: value

除attrNameSnakeCase的转换外，这些值不会被转义或修改。默认帮助文本包含此字符串（不含value）。

默认格式

默认格式会将beans转换为合理的指标命名，格式为：

domain_beanPropertyValue1_key1_key2_...keyN_attrName{beanpropertyName2="beanPropertyValue2", ...}: value

未设置的部分会被忽略。

测试

执行 mvn test 命令运行测试。

调试

可通过独立模式启动JMX scraper调试调用情况：

bash
git clone https://github.com/prometheus/jmx_exporter.git
cd jmx_exporter
mvn package
java -cp collector/target/collector*.jar  io.prometheus.jmx.JmxScraper  service:jmx:rmi:your_url

如需更详细日志（包括每个JMX调用的耗时），创建logging.properties文件：

handlers=java.util.logging.ConsoleHandler
java.util.logging.ConsoleHandler.level=ALL
io.prometheus.jmx.level=ALL
io.prometheus.jmx.shaded.io.prometheus.jmx.level=ALL

并在Java启动命令中添加：

bash
-Djava.util.logging.config.file=/path/to/logging.properties

安装

构建过程中会生成Debian二进制包，可用于将可执行文件安装到/usr/bin/jmx_exporter，配置文件位于/etc/jmx_exporter/jmx_exporter.yaml。

Java Agent的示例配置可参考：https://github.com/prometheus/jmx_exporter/tree/master/example_configs