commonMain.aws.smithy.kotlin.runtime.telemetry.trace.Tracer.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

The newest version!

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

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

import aws.smithy.kotlin.runtime.collections.Attributes
import aws.smithy.kotlin.runtime.collections.emptyAttributes
import aws.smithy.kotlin.runtime.telemetry.context.Context

/**
 * Entry point for creating [TraceSpan] instances.
 */
public interface Tracer {
    public companion object {
        /**
         * A [Tracer] that does nothing
         */
        public val None: Tracer = object : AbstractTracer() { }
    }

    /**
     * Creates a new span and makes it active in the current [Context].
     *
     * @param name the name of the span
     * @param parentContext the parent context to use for this span, if not set it is
     * implementation defined.
     */
    public fun createSpan(
        name: String,
        initialAttributes: Attributes = emptyAttributes(),
        spanKind: SpanKind = SpanKind.INTERNAL,
        parentContext: Context? = null,
    ): TraceSpan
}