13.9. 使用 Micrometer 和 Prometheus 来监控您的协调程序 OptaPlanner Java 应用程序

OptaPlanner 通过 Micrometer (Java 应用程序的指标检测库)公开指标。您可以将 Micrometer 与 Prometheus 搭配使用,以监控 button Timetable 应用程序中的 OptaPlanner solver。

先决条件

  • 您已经使用 Java 创建了 OptaPlanner 和应用。
  • 已安装 Prometheus。有关安装 Prometheus 的详情,请查看 Prometheus 网站。

流程

  1. 将 Micrometer Prometheus 依赖项添加到 series timetable pom.xml 文件中,其中 & lt;MICROMETER_VERSION > 是您安装的 Micrometer 版本:

    <dependency>
     <groupId>io.micrometer</groupId>
     <artifactId>micrometer-registry-prometheus</artifactId>
     <version><MICROMETER_VERSION></version>
    </dependency>
    注意

    还需要 micrometer-core 依赖项。但是,这个依赖项包含在 optaplanner-core 依赖项中,因此您不需要将其添加到 pom.xml 文件中。

  2. 将以下导入语句添加到 TimeTableApp.java 类中。

    import io.micrometer.core.instrument.Metrics;
    import io.micrometer.prometheus.PrometheusConfig;
    import io.micrometer.prometheus.PrometheusMeterRegistry;
  3. 将以下行添加到 TimeTableApp.java 类的主要方法的顶部,以便 Prometheus 可以在解决方案开始前从 com.sun.net.httpserver.HttpServer 中获取数据:

    PrometheusMeterRegistry prometheusRegistry = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);
    
            try {
                HttpServer server = HttpServer.create(new InetSocketAddress(8080), 0);
                server.createContext("/prometheus", httpExchange -> {
                    String response = prometheusRegistry.scrape();
                    httpExchange.sendResponseHeaders(200, response.getBytes().length);
                    try (OutputStream os = httpExchange.getResponseBody()) {
                        os.write(response.getBytes());
                    }
                });
    
                new Thread(server::start).start();
            } catch (IOException e) {
                throw new RuntimeException(e);
            }
    
            Metrics.addRegistry(prometheusRegistry);
    
            solve();
        }
  4. 添加以下行以控制问题解决时间。通过调整解决时间,您可以看到指标根据解决所花费的时间变化。

    withTerminationSpentLimit(Duration.ofMinutes(5)));
  5. 启动 established Timetable 应用程序。
  6. 在 Web 浏览器中打开 http://localhost:8080/prometheus,以查看 Prometheus 中的可计时应用程序。
  7. 打开监控系统,以查看 OptaPlanner 项目的指标。

    公开以下指标:

    • optaplanner_solver_errors_total :从测量开始解决时发生的错误总数。
    • optaplanner_solver_solve_duration_seconds_active_count :当前正在解决的解决者数量。
    • optaplanner_solver_solve_duration_seconds_max: 运行当前活跃解决器的最长时间。
    • optaplanner_solver_solve_duration_seconds_duration_sum :每个活跃解决者的 solve 持续时间的总和。例如,如果存在两个活动解决者,一个运行三分钟,另一个运行一分钟,则总解决时间为四分钟。