Apache Sling Commons Prometheus Metrics Exporter 使用教程

1. 项目的目录结构及介绍

sling-org-apache-sling-commons-metrics-prometheus/
├── src/
│   ├── main/
│   │   ├── java/
│   │   │   ├── org/
│   │   │   │   ├── apache/
│   │   │   │   │   ├── sling/
│   │   │   │   │   │   ├── commons/
│   │   │   │   │   │   │   ├── metrics/
│   │   │   │   │   │   │   │   ├── prometheus/
│   │   │   │   │   │   │   │   │   ├── PrometheusMetricsReporter.java
│   │   │   │   │   │   │   │   │   ├── PrometheusMetricsServlet.java
│   │   │   │   │   │   │   │   │   └── ...
│   │   │   │   │   │   │   │   └── ...
│   │   │   │   │   │   │   └── ...
│   │   │   │   │   │   └── ...
│   │   │   │   │   └── ...
│   │   │   │   └── ...
│   │   │   └── ...
│   │   └── resources/
│   │       └── META-INF/
│   │           └── services/
│   │               └── org.apache.sling.commons.metrics.MetricsReporter
│   └── test/
│       └── java/
│           └── org/
│               └── apache/
│                   └── sling/
│                       └── commons/
│                           └── metrics/
│                               └── prometheus/
│                                   └── ...
├── pom.xml
└── README.md

目录结构介绍

• src/main/java/: 包含项目的所有Java源代码。
  • org/apache/sling/commons/metrics/prometheus/: Prometheus Metrics Exporter的核心代码。
    • PrometheusMetricsReporter.java: 负责将Sling的指标导出到Prometheus。
    • PrometheusMetricsServlet.java: 提供一个HTTP接口，用于Prometheus抓取指标。
• src/main/resources/: 包含项目的配置文件和其他资源文件。
  • META-INF/services/: 包含服务发现文件，用于注册PrometheusMetricsReporter。
• src/test/java/: 包含项目的测试代码。
• pom.xml: Maven项目的配置文件。
• README.md: 项目的说明文档。

2. 项目的启动文件介绍

PrometheusMetricsReporter.java

PrometheusMetricsReporter.java 是项目的核心启动文件之一，负责初始化和配置Prometheus指标导出器。以下是该文件的关键部分：

package org.apache.sling.commons.metrics.prometheus;

import io.prometheus.client.CollectorRegistry;
import io.prometheus.client.dropwizard.DropwizardExports;
import org.apache.sling.commons.metrics.MetricsService;
import org.osgi.service.component.annotations.Activate;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Deactivate;
import org.osgi.service.component.annotations.Reference;

@Component(service = PrometheusMetricsReporter.class)
public class PrometheusMetricsReporter {

    @Reference
    private MetricsService metricsService;

    private DropwizardExports dropwizardExports;

    @Activate
    protected void activate() {
        dropwizardExports = new DropwizardExports(metricsService.getRegistry());
        CollectorRegistry.defaultRegistry.register(dropwizardExports);
    }

    @Deactivate
    protected void deactivate() {
        if (dropwizardExports != null) {
            CollectorRegistry.defaultRegistry.unregister(dropwizardExports);
        }
    }
}

PrometheusMetricsServlet.java

PrometheusMetricsServlet.java 提供了一个HTTP接口，用于Prometheus抓取指标。以下是该文件的关键部分：

package org.apache.sling.commons.metrics.prometheus;

import io.prometheus.client.exporter.MetricsServlet;
import org.osgi.service.component.annotations.Component;
import org.osgi.service