datadog.trace.api.profiling.Profiling Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of dd-trace-api Show documentation

dd-trace-api

The newest version!

package datadog.trace.api.profiling;

import datadog.trace.api.GlobalTracer;
import datadog.trace.api.Tracer;
import datadog.trace.api.internal.InternalTracer;

public interface Profiling {

  static Profiling get() {
    Tracer tracer = GlobalTracer.get();
    if (tracer instanceof InternalTracer) {
      return ((InternalTracer) tracer).getProfilingContext();
    }
    return NoOp.INSTANCE;
  }

  /**
   * Stateful API which restores the previous context when closed. This requires more memory so has
   * higher overhead than the stateless API.
   *
   * @return a profiling scope which can be closed to restore the current state.
   */
  default ProfilingScope newScope() {
    return ProfilingScope.NO_OP;
  }

  /**
   * Creates a decorator for the attribute, which can be used to set and clear contexts slightly
   * more efficiently than with string attributes.
   *
   * @param attribute the name of the attribute
   * @return a setter which can be used to set and clear profiling context
   */
  default ProfilingContextAttribute createContextAttribute(String attribute) {
    return ProfilingContextAttribute.NoOp.INSTANCE;
  }

  final class NoOp implements Profiling {
    public static final NoOp INSTANCE = new NoOp();
  }
}