commonMain.aws.smithy.kotlin.runtime.telemetry.trace.TracerProvider.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of telemetry-api-jvm Show documentation

API for telemetry data

There is a newer version: 1.3.23

/*
 * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 * SPDX-License-Identifier: Apache-2.0
 */

package aws.smithy.kotlin.runtime.telemetry.trace

/**
 * The entry point for creating [Tracer] instances.
 */
public interface TracerProvider {
    public companion object {
        /**
         * A [TracerProvider] that does nothing
         */
        public val None: TracerProvider = object : AbstractTracerProvider() { }
    }

    /**
     * Returns a unique [Tracer] scoped to be used by instrumentation code. The scope
     * and identity of that instrumentation code is uniquely identified by the name
     * and attributes.
     *
     * @param scope the name of the instrumentation scope
     */
    public fun getOrCreateTracer(scope: String): Tracer
}