Class TracingHandle
java.lang.Object
codes.grow.packages.datadogapm.tracing.TracingHandle
- All Implemented Interfaces:
AutoCloseable
Running tracing setup returned by
Tracing.initWith(codes.grow.packages.datadogapm.tracing.TracingConfig, codes.grow.packages.datadogapm.tracing.SpanExporterFactory).-
Constructor Summary
ConstructorsConstructorDescriptionTracingHandle(io.opentelemetry.sdk.OpenTelemetrySdk sdk, TracingConfig config) Wraps an OpenTelemetry SDK a service package built itself. -
Method Summary
Modifier and TypeMethodDescriptionvoidclose()Same asshutdown().config()The config this handle was created from.voidExports all finished spans, waiting at most the export timeout.voidforceFlush(Duration timeout) Exports all finished spans.forceFlushAsync(Duration timeout) AsynchronousforceFlush(Duration).booleanWhethershutdown()was called.io.opentelemetry.sdk.OpenTelemetrySdkThe OpenTelemetry SDK instance.io.opentelemetry.context.propagation.ContextPropagatorsThe configured propagators.voidshutdown()Flushes and shuts the tracer provider down; idempotent.Asynchronousshutdown().io.opentelemetry.api.trace.TracerReturns a tracer.io.opentelemetry.api.trace.TracerReturns a tracer with a scope version.io.opentelemetry.sdk.trace.SdkTracerProviderThe tracer provider.
-
Constructor Details
-
TracingHandle
Wraps an OpenTelemetry SDK a service package built itself. PreferTracing.initWith(codes.grow.packages.datadogapm.tracing.TracingConfig, codes.grow.packages.datadogapm.tracing.SpanExporterFactory); this handle is not made the helpers' default (Tracing.openTelemetry()).- Parameters:
sdk- the SDK (shut down with the handle)config- the config it was built from
-
-
Method Details
-
openTelemetry
public io.opentelemetry.sdk.OpenTelemetrySdk openTelemetry()The OpenTelemetry SDK instance.- Returns:
- SDK
-
tracerProvider
public io.opentelemetry.sdk.trace.SdkTracerProvider tracerProvider()The tracer provider.- Returns:
- tracer provider
-
propagators
public io.opentelemetry.context.propagation.ContextPropagators propagators()The configured propagators.- Returns:
- propagators
-
config
The config this handle was created from.- Returns:
- config
-
tracer
Returns a tracer.- Parameters:
name- instrumentation scope name- Returns:
- tracer
-
tracer
Returns a tracer with a scope version.- Parameters:
name- instrumentation scope nameversion- instrumentation scope version- Returns:
- tracer
-
forceFlush
public void forceFlush()Exports all finished spans, waiting at most the export timeout.- Throws:
TimeoutException- when the export does not finish in time
-
forceFlush
Exports all finished spans.- Parameters:
timeout- maximum wait- Throws:
TimeoutException- when the export does not finish (or fails) in time
-
forceFlushAsync
AsynchronousforceFlush(Duration).- Parameters:
timeout- maximum wait- Returns:
- completes when flushed
-
shutdown
public void shutdown()Flushes and shuts the tracer provider down; idempotent.- Throws:
TimeoutException- when shutting down takes longer than the export timeout
-
shutdownAsync
Asynchronousshutdown().- Returns:
- completes when shut down
-
isShutdown
public boolean isShutdown()Whethershutdown()was called.- Returns:
- shutdown flag
-
close
public void close()Same asshutdown().- Specified by:
closein interfaceAutoCloseable
-