Class TelemetryHandle
java.lang.Object
codes.grow.packages.otelcollector.TelemetryHandle
- All Implemented Interfaces:
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 Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Same asshutdown().config()Returns the collector config in use.io.opentelemetry.api.metrics.LongCountercounter(String name, InstrumentOptions options) Monotonic counter (OTLPsum, cumulative).voidExports everything buffered in every enabled signal, waiting at mostDEFAULT_FLUSH_TIMEOUT.voidforceFlush(Duration timeout) Exports everything buffered in every enabled signal.forceFlushAsync(Duration timeout) AsynchronousforceFlush(Duration).io.opentelemetry.api.metrics.DoubleGaugegauge(String name, InstrumentOptions options) Synchronous gauge (OTLPgauge).io.opentelemetry.api.metrics.DoubleHistogramhistogram(String name, InstrumentOptions options) Histogram with optional explicit bucket boundaries.booleanReturns whethershutdown()was called.Returns the OTLP log client (SPEC section 4).A logger writing tologClient()(drops records when logs are disabled).A logger with fixed attributes.io.opentelemetry.api.logs.LoggerProviderReturns the OpenTelemetry logger provider for log appenders (no-op when logs are disabled).io.opentelemetry.api.metrics.Metermeter()A meter namedOtelCollectorMetrics.DEFAULT_METER_NAME.io.opentelemetry.api.metrics.MeterA meter.io.opentelemetry.api.metrics.MeterProviderReturns the meter provider (no-op when metrics are disabled).io.opentelemetry.api.OpenTelemetryReturns the combined OpenTelemetry instance (tracer, meter and logger providers, propagators).io.opentelemetry.sdk.resources.Resourceresource()Returns the shared resource (SDK defaults plus detected, configured and service attributes).Returns the resource attributes added to the SDK defaults (detected < configured < service fields).voidshutdown()Flushes and shuts every provider down (log client, logger, meter and tracer providers).Asynchronousshutdown().io.opentelemetry.api.trace.Tracertracer()A tracer named after the service.io.opentelemetry.api.trace.TracerA tracer.io.opentelemetry.api.trace.TracerA tracer with a scope version.io.opentelemetry.api.trace.TracerProviderReturns the tracer provider (no-op when traces are disabled).tracing()Returns the tracing handle.io.opentelemetry.api.metrics.LongUpDownCounterupDownCounter(String name, InstrumentOptions options) Up/down counter (OTLP non-monotonicsum).
-
Field Details
-
DEFAULT_FLUSH_TIMEOUT
Default deadline offorceFlush().
-
-
Method Details
-
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
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
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
A tracer.- Parameters:
name- instrumentation scope name- Returns:
- the tracer
-
tracer
A tracer with a scope version.- Parameters:
name- instrumentation scope nameversion- 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()A meter namedOtelCollectorMetrics.DEFAULT_METER_NAME.- Returns:
- the meter
-
meter
A meter.- Parameters:
name- instrumentation scope name- Returns:
- the meter
-
counter
Monotonic counter (OTLPsum, cumulative).- Parameters:
name- instrument nameoptions- description, unit, meter- Returns:
- the counter
-
upDownCounter
public io.opentelemetry.api.metrics.LongUpDownCounter upDownCounter(String name, InstrumentOptions options) Up/down counter (OTLP non-monotonicsum).- Parameters:
name- instrument nameoptions- 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 nameoptions- description, unit, meter, boundaries- Returns:
- the histogram
-
gauge
Synchronous gauge (OTLPgauge).- Parameters:
name- instrument nameoptions- 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
Returns the OTLP log client (SPEC section 4).- Returns:
- the client, empty when logs are disabled
-
logger
A logger writing tologClient()(drops records when logs are disabled).- Parameters:
name- logger name- Returns:
- the logger
-
logger
A logger with fixed attributes.- Parameters:
name- logger nameattributes- attributes added to every record- Returns:
- the logger
-
forceFlush
public void forceFlush()Exports everything buffered in every enabled signal, waiting at mostDEFAULT_FLUSH_TIMEOUT.- Throws:
TimeoutException- when the flush does not complete in time
-
forceFlush
Exports everything buffered in every enabled signal.- Parameters:
timeout- deadline- Throws:
TimeoutException- when the flush does not complete in timeUnavailableException- when an exporter failed
-
forceFlushAsync
AsynchronousforceFlush(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
Asynchronousshutdown().- Returns:
- a future completed when shut down
-
isShutdown
public boolean isShutdown()Returns whethershutdown()was called.- Returns:
- true once shut down
-
close
public void close()Same asshutdown().- Specified by:
closein interfaceAutoCloseable
-