org.apache.rocketmq.shaded.io.opentelemetry.sdk.metrics.internal.debug.DebugConfig Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of rocketmq-client-java

There is a newer version: 5.0.7

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

package org.apache.rocketmq.shaded.io.opentelemetry.sdk.metrics.internal.debug;

import java.util.Locale;

/**
 * Determines if the SDK is in debugging mode (captures stack traces) or not.
 *
 * This class is internal and is hence not for public use. Its APIs are unstable and can change
 * at any time.
 */
public final class DebugConfig {
  private static final String ENABLE_METRICS_DEBUG_PROPERTY = "otel.experimental.sdk.metrics.debug";
  private static boolean enabled;

  private DebugConfig() {}

  static {
    // Attempt to mirror the logic in DefaultConfigProperties here...
    enabled =
        "true".equalsIgnoreCase(System.getProperty(ENABLE_METRICS_DEBUG_PROPERTY))
            || "true"
                .equalsIgnoreCase(
                    System.getenv(
                        ENABLE_METRICS_DEBUG_PROPERTY.toLowerCase(Locale.ROOT).replace('.', '_')));
  }

  /**
   * Returns true if metrics debugging is enabled.
   *
   * This will grab stack traces on instrument/view registration.
   */
  public static boolean isMetricsDebugEnabled() {
    return enabled;
  }

  /** Returns the message we send for how to enable better metrics debugging. */
  public static String getHowToEnableMessage() {
    return "To enable better debugging, run your JVM with -D"
        + ENABLE_METRICS_DEBUG_PROPERTY
        + "=true";
  }

  /** A mechanism to enable debugging for testing without having to recompile. */
  // Visible for testing
  public static void enableForTesting(boolean value) {
    enabled = value;
  }
}