com.rabbitmq.perf.PrometheusMetrics Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of perf-test Show documentation
A Java-based performance testing tool for RabbitMQ.
The newest version!
// Copyright (c) 2018-2023 Broadcom. All Rights Reserved.
// The term "Broadcom" refers to Broadcom Inc. and/or its subsidiaries.
//
// This software, the RabbitMQ Java client library, is triple-licensed under the
// Mozilla Public License 2.0 ("MPL"), the GNU General Public License version 2
// ("GPL") and the Apache License version 2 ("ASL"). For the MPL, please see
// LICENSE-MPL-RabbitMQ. For the GPL, please see LICENSE-GPL2.  For the ASL,
// please see LICENSE-APACHE2.
//
// This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
// either express or implied. See the LICENSE file for specific language governing
// rights and limitations of this software.
//
// If you have any questions regarding licensing, please contact us at
// [email protected].
package com.rabbitmq.perf;

import static com.rabbitmq.perf.Utils.intArg;
import static com.rabbitmq.perf.Utils.strArg;

import com.sun.net.httpserver.HttpServer;
import io.micrometer.core.instrument.composite.CompositeMeterRegistry;
import io.micrometer.prometheusmetrics.PrometheusConfig;
import io.micrometer.prometheusmetrics.PrometheusMeterRegistry;
import java.io.IOException;
import java.io.OutputStream;
import java.net.InetSocketAddress;
import java.nio.charset.StandardCharsets;
import java.util.concurrent.atomic.AtomicBoolean;
import org.apache.commons.cli.Option;
import org.apache.commons.cli.Options;

/** */
public class PrometheusMetrics implements Metrics {

  private volatile HttpServer server;
  private volatile Runnable serverStart = () -> {};
  private volatile Runnable serverStop = () -> {};

  private volatile PrometheusMeterRegistry registry;

  public Options options() {
    Options options = new Options();
    options.addOption(new Option("mpr", "metrics-prometheus", false, "enable Prometheus metrics"));
    options.addOption(
        new Option(
            "mpe",
            "metrics-prometheus-endpoint",
            true,
            "the HTTP metrics endpoint, default is /metrics"));
    options.addOption(
        new Option(
            "mpp",
            "metrics-prometheus-port",
            true,
            "the port to launch the HTTP metrics endpoint on, default is 8080"));

    return options;
  }

  public void configure(ConfigurationContext context) throws Exception {
    CommandLineProxy cmd = context.cmd();
    CompositeMeterRegistry meterRegistry = context.meterRegistry();
    if (isEnabled(cmd)) {
      registry = new PrometheusMeterRegistry(PrometheusConfig.DEFAULT);
      meterRegistry.add(registry);
      int prometheusHttpEndpointPort = intArg(cmd, "mpp", 8080);
      String endpoint = strArg(cmd, "mpe", "metrics");
      String prometheusHttpEndpoint = endpoint.startsWith("/") ? endpoint : "/" + endpoint;
      AtomicBoolean serverStarted = new AtomicBoolean(false);
      this.serverStart =
          () -> {
            try {
              server = HttpServer.create(new InetSocketAddress(prometheusHttpEndpointPort), 0);
            } catch (IOException e) {
              throw new PerfTestException("Error while starting Prometheus HTTP server", e);
            }
            server.createContext(
                prometheusHttpEndpoint,
                exchange -> {
                  exchange.getResponseHeaders().set("Content-Type", "text/plain");
                  byte[] content = registry.scrape().getBytes(StandardCharsets.UTF_8);
                  exchange.sendResponseHeaders(200, content.length);
                  try (OutputStream out = exchange.getResponseBody()) {
                    out.write(content);
                  }
                });
            server.start();
            serverStarted.set(true);
          };
      this.serverStop =
          () -> {
            if (serverStarted.compareAndSet(true, false)) {
              server.stop(0);
            }
          };
    } else {
      this.serverStart = () -> {};
      this.serverStop = () -> {};
    }
  }

  @Override
  public void start() {
    this.serverStart.run();
  }

  public void close() throws Exception {
    this.serverStop.run();
    if (registry != null) {
      registry.close();
    }
  }

  @Override
  public String toString() {
    return "Prometheus Metrics";
  }
}