Prometheus JMX Exporter 中字符串属性转标签的配置实践

背景介绍

Prometheus JMX Exporter 是一个用于将 Java 应用程序的 JMX 指标导出为 Prometheus 格式的工具。在实际使用中，我们经常需要将 JMX 中的字符串属性转换为 Prometheus 指标的标签，以便更好地组织和查询监控数据。

问题现象

在使用 JMX Exporter 监控 YouTrack 应用时，发现配置文件中虽然指定了多个字符串属性作为标签（如 HubIntegrationStatus、PermissionCacheStatus 等），但这些属性并没有如预期那样出现在导出的指标标签中。

问题排查

经过深入分析，发现问题的根源在于 Docker 容器中同时挂载了两个不同版本的 JMX Exporter 代理：

1. 一个是较新的开发版本（main 分支）
2. 另一个是旧版发布版本（1.1.0）

由于旧版本不支持将字符串属性转换为标签的功能，导致配置看似正确但实际未生效。

解决方案

正确配置方法

要确保字符串属性能够正确转换为标签，需要：

1. 使用支持该功能的最新版本 JMX Exporter
2. 正确配置 metricCustomizers 和 attributesAsLabels 部分

示例配置：

metricCustomizers:
  - mbeanFilter:
      domain: jetbrains.youtrack
      properties:
        type: Hub
        name: HubIntegration
    attributesAsLabels:
      - HubIntegrationStatus
      - PermissionCacheStatus
      - RunningJob
      - EventSyncStatusStatus

最佳实践

为了避免版本冲突问题，建议采用以下部署方式：

1. 使用多阶段构建确保只包含一个版本的代理
2. 直接从源码构建最新版本

示例 Dockerfile：

FROM maven:3.9.9-eclipse-temurin-21-jammy AS builder
RUN git clone https://github.com/prometheus/jmx_exporter.git /tmp/jmx_exporter
WORKDIR /tmp/jmx_exporter
RUN mvn -DskipTests=true package

FROM jetbrains/youtrack:2025.1.62967
COPY --from=builder /tmp/jmx_exporter/jmx_prometheus_javaagent/target/jmx_prometheus_javaagent-*-post.jar /opt/app/jmx_prometheus_javaagent.jar

效果验证

正确配置后，导出的指标将包含所有指定的字符串属性作为标签，例如：

jetbrains_youtrack_Hub_HubEventsFailed{
  EventSyncStatusStatus="Active, syncing everything",
  HubIntegrationStatus="Active and working",
  PermissionCacheStatus="Hub permission management",
  RunningJob="None",
  name="HubIntegration"
} 0.0

总结

在使用 Prometheus JMX Exporter 时，要特别注意：

1. 确保使用支持所需功能的最新版本
2. 避免同时加载多个版本的代理
3. 正确配置 attributesAsLabels 以实现字符串属性到标签的转换
4. 采用容器化部署时，推荐使用多阶段构建确保环境一致性

通过以上实践，可以充分利用 JMX Exporter 的功能，实现更灵活、更强大的 Java 应用监控方案。