datadog.trace.bootstrap

Class BootstrapInitializationTelemetry

java.lang.Object

datadog.trace.bootstrap.BootstrapInitializationTelemetry

Direct Known Subclasses:

BootstrapInitializationTelemetry.JsonBased, BootstrapInitializationTelemetry.NoOp

public abstract class BootstrapInitializationTelemetry
extends Object

Thread safe telemetry class used to relay information about tracer activation.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BootstrapInitializationTelemetry.ForwarderJsonSender
static class	BootstrapInitializationTelemetry.JsonBased
static interface	BootstrapInitializationTelemetry.JsonSender
static class	BootstrapInitializationTelemetry.NoOp

Constructor Summary

Constructors

Constructor and Description
BootstrapInitializationTelemetry()

Method Summary

Modifier and Type	Method and Description
static BootstrapInitializationTelemetry	createFromForwarderPath(String forwarderPath) Constructs a JSON-based instrumentation telemetry that forwards through a helper executable - indicated by forwarderPath
abstract void	finish()
abstract void	initMetaInfo(String attr, String value) Adds meta information about the process to the initialization telemetry Does NOT support overriding an attr, each attr should be once and only once
abstract void	markIncomplete()
static BootstrapInitializationTelemetry	noOpInstance() Returns a singleton no op instance of initialization telemetry
abstract void	onAbort(String reasonCode) Indicates that an abort condition occurred during the bootstrapping process Abort conditions are assumed to leave the bootstrapping process incomplete.
abstract void	onError(String reasonCode)
abstract void	onError(Throwable t) Indicates that an exception occurred during the bootstrapping process By default the exception is assumed to NOT have fully stopped the initialization of the tracer.
abstract void	onFatalError(Throwable t) Indicates an exception that occurred during the bootstrapping process that left initialization incomplete.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

BootstrapInitializationTelemetry

public BootstrapInitializationTelemetry()

Method Detail

noOpInstance

public static BootstrapInitializationTelemetry noOpInstance()

Returns a singleton no op instance of initialization telemetry

createFromForwarderPath

public static BootstrapInitializationTelemetry createFromForwarderPath(String forwarderPath)

Constructs a JSON-based instrumentation telemetry that forwards through a helper executable - indicated by forwarderPath

Parameters:

forwarderPath - - a String - path to forwarding executable

initMetaInfo

public abstract void initMetaInfo(String attr,
                                  String value)

Adds meta information about the process to the initialization telemetry Does NOT support overriding an attr, each attr should be once and only once

onAbort

public abstract void onAbort(String reasonCode)

Indicates that an abort condition occurred during the bootstrapping process Abort conditions are assumed to leave the bootstrapping process incomplete. markIncomplete()

onError

public abstract void onError(Throwable t)

Indicates that an exception occurred during the bootstrapping process By default the exception is assumed to NOT have fully stopped the initialization of the tracer.

If this exception stops the core bootstrapping of the tracer, then markIncomplete() should also be called.

onFatalError

public abstract void onFatalError(Throwable t)

Indicates an exception that occurred during the bootstrapping process that left initialization incomplete. Equivalent to calling onError(Throwable) and markIncomplete()

onError

public abstract void onError(String reasonCode)

markIncomplete

public abstract void markIncomplete()

finish

public abstract void finish()