使用 Prometheus 检测 Java 应用程序

Question

我正在尝试使用 prometheus java 客户端库监控 Java 应用程序中的多个指标，但我在一次监控多个指标时遇到了困难。如果我只注册和抓取一个指标，一切似乎都可以正常工作，并且我可以使用 prometheus 应用程序查看该指标，但如果我尝试公开和监控多个指标，那么只有其中一个指标可见。

所以如果我有一个带有如下检测类的应用程序

package com.telemetryserver.Instrumentation;

import io.prometheus.client.*;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;

public class Instrumented_Class extends HttpServlet
{
    private static Instrumented_Class _instance = null;

    public static final Gauge metric_1 = Gauge.build().name("metric_1").help("metric_1").register();
    //public static final Gauge metric_2 = Gauge.build().name("metric_2").help("metric_2").register();

    public static Instrumented_Class getInstance()
    {
        if (_instance == null)
            _instance = new Instrumented_Class();

        return _instance;
    }

    //Getters and Setters

    public static void setMetric_1(double val) { metric_1.set(val); }

    public static double getMetric_1() { return metric_1.get(); }

    //public static void setMetric_2(double val) { metric_2.set(val); }

    //public static double getMetric_2() { return metric_2.get(); }

    @Override
    protected void doGet(final HttpServletRequest req, final HttpServletResponse resp) throws ServletException, IOException
    {

        double metric_1 = Instrumented_Class.getMetric_1();
        Instrumented_Class.setMetric_1(metric_1 + 1);

        //double metric_2 = Instrumented_Class.getMetric_2();
        //Instrumented_Class.setMetric_2(metric_2 + 2);

        resp.getWriter().println("Hello from Instrumented_Class!!!," +
                " metric_1 = " + metric_1
                //+ " metric_2 = " + metric_2
        );
    }
}

主类为

package com.telemetryserver.client;


import com.telemetryserver.Instrumentation.*;
import io.prometheus.client.exporter.MetricsServlet;
import io.prometheus.client.hotspot.DefaultExports;
import org.eclipse.jetty.server.Server;
import org.eclipse.jetty.servlet.ServletContextHandler;
import org.eclipse.jetty.servlet.ServletHolder;

public class TelemetryApp
{
    public static void main(String[] args)
    {
        startTestServer(2018);
    }


    public static void startTestServer(int port)
    {
        try
        {
            Server server = new Server(port);
            ServletContextHandler context = new ServletContextHandler();
            context.setContextPath("/");
            server.setHandler(context);

            //Expose our Instrumented servlet.
            context.addServlet(new ServletHolder(Instrumented_Class.getInstance()), "/");

            //Prometheus Metrics Servlet
            context.addServlet(new ServletHolder(new MetricsServlet()), "/metrics");

            // Add metrics about CPU, JVM memory etc.
            //DefaultExports.initialize();

            // Start the webserver.
            server.start();
            server.join();
        }
        catch (Exception ex)
        {
            ex.printStackTrace();
        }
    }
 }

也使用 YAML 文件

global:
  scrape_interval:     2s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
  evaluation_interval: 2s # Evaluate rules every 15 seconds. The default is every 1 minute.
  # scrape_timeout is set to the global default (10s).

# Alertmanager configuration
alerting:
  alertmanagers:
  - static_configs:
    - targets:
      # - alertmanager:9093

# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
rule_files:
  # - "first_rules.yml"
  # - "second_rules.yml"

# A scrape configuration containing exactly one endpoint to scrape:
# Here it's Prometheus itself.
scrape_configs:
  # The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
  - job_name: 'telemetryserver'

    metrics_path : '/metrics'
    # scheme defaults to 'http'.

    static_configs:
    - targets: ['localhost:2018']

我可以通过运行 prometheus 然后运行查询“metric_1”来监控指标“metric_1”。这一切都很好，但是如果我通过取消注释检测类中的行来添加另一个名为 metric_2 的指标，那么 metric_2 会显示在 prometheus 上，但 metric_1 会停止显示。此外，如果我取消注释 DefaultExports.initialize(); 行（它添加了所有默认的 prometheus 指标），那么 metric_1 和 metric_2 都会停止显示，并且只显示一个名为“jvm_threads_current”的默认指标。

有人可以告诉我如何在 prometheus 中监控多个指标吗？任何帮助表示赞赏。

Answer 1

您的申请很好。

只需确保通过点击/metrics 端点对其进行测试。这就是 prometheus 从您的应用程序中收集指标的方式。

当我在本地测试它时，使用指标和导出 JVM 指标，我有一个类似于这个的输出：

*** lots of jvm metrics
jvm_gc_collection_seconds_count{gc="PS MarkSweep",} 0.0
jvm_gc_collection_seconds_sum{gc="PS MarkSweep",} 0.0
# HELP metric_2 metric_2
# TYPE metric_2 gauge
metric_2 12.0
# HELP metric_1 metric_1
# TYPE metric_1 gauge
metric_1 6.0
# HELP jvm_threads_current Current thread count of a JVM
# TYPE jvm_threads_current gauge
jvm_threads_current 16.0

其中包含您的自定义指标以及来自 JVM 的指标。

您的 Prometheus 配置也没有问题。要测试集成，请转到“状态”>“目标”，您应该会看到您的服务，如下图所示：

然后转到“Graph”页面并输入表达式{job="telemetryserver"} 以检查 Prometheus 是否实际上正在从您的应用程序中收集指标。您应该会看到类似以下内容：