Class TelemetryHandle

java.lang.Object
codes.grow.packages.otelcollector.TelemetryHandle
All Implemented Interfaces:
AutoCloseable

public final class TelemetryHandle extends Object implements AutoCloseable
A running telemetry setup (all three signals) created by OtelCollectorTelemetry.initTelemetry(). Disabled signals hand out no-op tracers, meters and loggers. shutdown() flushes and stops every provider and is idempotent.
  • Field Details

    • DEFAULT_FLUSH_TIMEOUT

      public static final Duration DEFAULT_FLUSH_TIMEOUT
      Default deadline of forceFlush().
  • Method Details

    • config

      public OtelCollectorConfig config()
      Returns the collector config in use.
      Returns:
      the config
    • resource

      public io.opentelemetry.sdk.resources.Resource resource()
      Returns the shared resource (SDK defaults plus detected, configured and service attributes).
      Returns:
      the resource
    • resourceAttributes

      public Map<String,Object> resourceAttributes()
      Returns the resource attributes added to the SDK defaults (detected < configured < service fields).
      Returns:
      immutable map
    • openTelemetry

      public io.opentelemetry.api.OpenTelemetry openTelemetry()
      Returns the combined OpenTelemetry instance (tracer, meter and logger providers, propagators).
      Returns:
      the instance
    • tracing

      public Optional<TracingHandle> tracing()
      Returns the tracing handle.
      Returns:
      the handle, empty when traces are disabled
    • tracerProvider

      public io.opentelemetry.api.trace.TracerProvider tracerProvider()
      Returns the tracer provider (no-op when traces are disabled).
      Returns:
      the provider
    • tracer

      public io.opentelemetry.api.trace.Tracer tracer()
      A tracer named after the service.
      Returns:
      the tracer
    • tracer

      public io.opentelemetry.api.trace.Tracer tracer(String name)
      A tracer.
      Parameters:
      name - instrumentation scope name
      Returns:
      the tracer
    • tracer

      public io.opentelemetry.api.trace.Tracer tracer(String name, String version)
      A tracer with a scope version.
      Parameters:
      name - instrumentation scope name
      version - scope version
      Returns:
      the tracer
    • meterProvider

      public io.opentelemetry.api.metrics.MeterProvider meterProvider()
      Returns the meter provider (no-op when metrics are disabled).
      Returns:
      the provider
    • meter

      public io.opentelemetry.api.metrics.Meter meter()
      Returns:
      the meter
    • meter

      public io.opentelemetry.api.metrics.Meter meter(String name)
      A meter.
      Parameters:
      name - instrumentation scope name
      Returns:
      the meter
    • counter

      public io.opentelemetry.api.metrics.LongCounter counter(String name, InstrumentOptions options)
      Monotonic counter (OTLP sum, cumulative).
      Parameters:
      name - instrument name
      options - description, unit, meter
      Returns:
      the counter
    • upDownCounter

      public io.opentelemetry.api.metrics.LongUpDownCounter upDownCounter(String name, InstrumentOptions options)
      Up/down counter (OTLP non-monotonic sum).
      Parameters:
      name - instrument name
      options - description, unit, meter
      Returns:
      the counter
    • histogram

      public io.opentelemetry.api.metrics.DoubleHistogram histogram(String name, InstrumentOptions options)
      Histogram with optional explicit bucket boundaries.
      Parameters:
      name - instrument name
      options - description, unit, meter, boundaries
      Returns:
      the histogram
    • gauge

      public io.opentelemetry.api.metrics.DoubleGauge gauge(String name, InstrumentOptions options)
      Synchronous gauge (OTLP gauge).
      Parameters:
      name - instrument name
      options - description, unit, meter
      Returns:
      the gauge
    • loggerProvider

      public io.opentelemetry.api.logs.LoggerProvider loggerProvider()
      Returns the OpenTelemetry logger provider for log appenders (no-op when logs are disabled).
      Returns:
      the provider
    • logClient

      public Optional<LogClient> logClient()
      Returns the OTLP log client (SPEC section 4).
      Returns:
      the client, empty when logs are disabled
    • logger

      public Logger logger(String name)
      A logger writing to logClient() (drops records when logs are disabled).
      Parameters:
      name - logger name
      Returns:
      the logger
    • logger

      public Logger logger(String name, Map<String,?> attributes)
      A logger with fixed attributes.
      Parameters:
      name - logger name
      attributes - attributes added to every record
      Returns:
      the logger
    • forceFlush

      public void forceFlush()
      Exports everything buffered in every enabled signal, waiting at most DEFAULT_FLUSH_TIMEOUT.
      Throws:
      TimeoutException - when the flush does not complete in time
    • forceFlush

      public void forceFlush(Duration timeout)
      Exports everything buffered in every enabled signal.
      Parameters:
      timeout - deadline
      Throws:
      TimeoutException - when the flush does not complete in time
      UnavailableException - when an exporter failed
    • forceFlushAsync

      public CompletableFuture<Void> forceFlushAsync(Duration timeout)
      Asynchronous forceFlush(Duration).
      Parameters:
      timeout - deadline
      Returns:
      a future completed when flushed
    • shutdown

      public void shutdown()
      Flushes and shuts every provider down (log client, logger, meter and tracer providers). Idempotent. A global registration stays in place (OpenTelemetry allows one per JVM).
      Throws:
      OtelCollectorException - when a provider fails to shut down in time
    • shutdownAsync

      public CompletableFuture<Void> shutdownAsync()
      Asynchronous shutdown().
      Returns:
      a future completed when shut down
    • isShutdown

      public boolean isShutdown()
      Returns whether shutdown() was called.
      Returns:
      true once shut down
    • close

      public void close()
      Same as shutdown().
      Specified by:
      close in interface AutoCloseable