JmxScraperContainer.java

/*
 * Copyright The OpenTelemetry Authors
 * SPDX-License-Identifier: Apache-2.0
 */

package io.opentelemetry.contrib.jmxscraper;

import static org.assertj.core.api.Assertions.assertThat;

import com.google.errorprone.annotations.CanIgnoreReturnValue;
import java.time.Duration;
import java.util.ArrayList;
import java.util.HashSet;
import java.util.List;
import java.util.Locale;
import java.util.Set;
import org.testcontainers.containers.GenericContainer;
import org.testcontainers.containers.wait.strategy.Wait;
import org.testcontainers.utility.MountableFile;

/** Test container that allows to execute {@link JmxScraper} in an isolated container */
public class JmxScraperContainer extends GenericContainer<JmxScraperContainer> {

  private final String endpoint;
  private final Set<String> targetSystems;
  private String serviceUrl;
  private int intervalMillis;
  private final Set<String> customYamlFiles;
  private String user;
  private String password;
  private final List<String> extraJars;

  public JmxScraperContainer(String otlpEndpoint, String baseImage) {
    super(baseImage);

    String scraperJarPath = System.getProperty("shadow.jar.path");
    assertThat(scraperJarPath).isNotNull();

    this.withCopyFileToContainer(MountableFile.forHostPath(scraperJarPath), "/scraper.jar")
        .waitingFor(
            Wait.forLogMessage(".*JMX scraping started.*", 1)
                .withStartupTimeout(Duration.ofSeconds(10)));

    this.endpoint = otlpEndpoint;
    this.targetSystems = new HashSet<>();
    this.customYamlFiles = new HashSet<>();
    this.intervalMillis = 1000;
    this.extraJars = new ArrayList<>();
  }

  @CanIgnoreReturnValue
  public JmxScraperContainer withTargetSystem(String targetSystem) {
    targetSystems.add(targetSystem);
    return this;
  }

  @CanIgnoreReturnValue
  public JmxScraperContainer withIntervalMillis(int intervalMillis) {
    this.intervalMillis = intervalMillis;
    return this;
  }

  @CanIgnoreReturnValue
  public JmxScraperContainer withRmiServiceUrl(String host, int port) {
    // TODO: adding a way to provide 'host:port' syntax would make this easier for end users
    return withServiceUrl(
        String.format(
            Locale.getDefault(), "service:jmx:rmi:///jndi/rmi://%s:%d/jmxrmi", host, port));
  }

  @CanIgnoreReturnValue
  public JmxScraperContainer withServiceUrl(String serviceUrl) {
    this.serviceUrl = serviceUrl;
    return this;
  }

  /**
   * Sets JMX user login
   *
   * @param user user login
   * @return this
   */
  @CanIgnoreReturnValue
  public JmxScraperContainer withUser(String user) {
    this.user = user;
    return this;
  }

  /**
   * Sets JMX password
   *
   * @param password user password
   * @return this
   */
  @CanIgnoreReturnValue
  public JmxScraperContainer withPassword(String password) {
    this.password = password;
    return this;
  }

  /**
   * Adds path to an extra jar for classpath
   *
   * @param jarPath path to an extra jar that should be added to jmx scraper classpath
   * @return this
   */
  @CanIgnoreReturnValue
  public JmxScraperContainer withExtraJar(String jarPath) {
    this.extraJars.add(jarPath);
    return this;
  }

  @CanIgnoreReturnValue
  public JmxScraperContainer withCustomYaml(String yamlPath) {
    this.customYamlFiles.add(yamlPath);
    return this;
  }

  @Override
  public void start() {
    // for now only configure through JVM args
    List<String> arguments = new ArrayList<>();
    arguments.add("java");
    arguments.add("-Dotel.metrics.exporter=otlp");
    arguments.add("-Dotel.exporter.otlp.endpoint=" + endpoint);

    if (!targetSystems.isEmpty()) {
      arguments.add("-Dotel.jmx.target.system=" + String.join(",", targetSystems));
    }

    if (serviceUrl == null) {
      throw new IllegalStateException("Missing service URL");
    }
    arguments.add("-Dotel.jmx.service.url=" + serviceUrl);
    arguments.add("-Dotel.jmx.interval.milliseconds=" + intervalMillis);

    if (user != null) {
      arguments.add("-Dotel.jmx.username=" + user);
    }
    if (password != null) {
      arguments.add("-Dotel.jmx.password=" + password);
    }

    if (!customYamlFiles.isEmpty()) {
      for (String yaml : customYamlFiles) {
        this.withCopyFileToContainer(MountableFile.forClasspathResource(yaml), yaml);
      }
      arguments.add("-Dotel.jmx.config=" + String.join(",", customYamlFiles));
    }

    if (extraJars.isEmpty()) {
      // using "java -jar" to start
      arguments.add("-jar");
      arguments.add("/scraper.jar");
    } else {
      // using "java -cp" to start
      arguments.add("-cp");
      arguments.add("/scraper.jar:" + String.join(":", extraJars));
      arguments.add("io.opentelemetry.contrib.jmxscraper.JmxScraper");
    }

    this.withCommand(arguments.toArray(new String[0]));

    logger().info("Starting scraper with command: " + String.join(" ", arguments));

    super.start();
  }
}