Package io.opentelemetry.sdk.common

Class InstrumentationLibraryInfo

java.lang.Object

io.opentelemetry.sdk.common.InstrumentationLibraryInfo

@Immutable
public abstract class InstrumentationLibraryInfo
extends Object

Holds information about the instrumentation library specified when creating an instance of Tracer using the Tracer Provider.

Method Summary

Modifier and Type	Method	Description
static InstrumentationLibraryInfo	create(String name, String version)	Creates a new instance of InstrumentationLibraryInfo.
static InstrumentationLibraryInfo	create(String name, String version, String schemaUrl)	Creates a new instance of InstrumentationLibraryInfo.
static InstrumentationLibraryInfo	empty()	Returns an "empty" InstrumentationLibraryInfo.
abstract String	getName()	Returns the name of the instrumentation library.
abstract String	getSchemaUrl()	Returns the URL of the schema used by this instrumentation library, or null if not available.
abstract String	getVersion()	Returns the version of the instrumentation library, or null if not available.

Methods inherited from class java.lang.Object

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

Method Detail

create

public static InstrumentationLibraryInfo create(String name,
                                                @Nullable
                                                String version)

Creates a new instance of InstrumentationLibraryInfo.

Parameters:

name - name of the instrumentation library (e.g., "io.opentelemetry.contrib.mongodb"), must not be null

version - version of the instrumentation library (e.g., "1.0.0"), might be null

Returns:

the new instance

create

public static InstrumentationLibraryInfo create(String name,
                                                @Nullable
                                                String version,
                                                @Nullable
                                                String schemaUrl)

Creates a new instance of InstrumentationLibraryInfo.

Parameters:

name - name of the instrumentation library (e.g., "io.opentelemetry.contrib.mongodb"), must not be null

version - version of the instrumentation library (e.g., "1.0.0"), might be null

schemaUrl - the URL of the OpenTelemetry schema being used by this instrumentation library.

Returns:

the new instance

Since:

1.4.0

empty

public static InstrumentationLibraryInfo empty()

Returns an "empty" InstrumentationLibraryInfo.

Returns:

an "empty" InstrumentationLibraryInfo.

getName

public abstract String getName()

Returns the name of the instrumentation library.

Returns:

the name of the instrumentation library.

getVersion

@Nullable
public abstract String getVersion()

Returns the version of the instrumentation library, or null if not available.

Returns:

the version of the instrumentation library, or null if not available.

getSchemaUrl

@Nullable
public abstract String getSchemaUrl()

Returns the URL of the schema used by this instrumentation library, or null if not available.

Returns:

the URL of the schema used by this instrumentation library, or null if not available.