io.opentelemetry.sdk.trace.ReadableSpan Maven / Gradle / Ivy
Show all versions of opentelemetry-sdk-trace Show documentation
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package io.opentelemetry.sdk.trace;
import io.opentelemetry.api.trace.Span;
import io.opentelemetry.api.trace.SpanContext;
import io.opentelemetry.sdk.common.InstrumentationLibraryInfo;
import io.opentelemetry.sdk.trace.data.SpanData;
/** The extend Span interface used by the SDK. */
public interface ReadableSpan {
/**
* Returns the {@link SpanContext} of the {@code Span}.
*
* Equivalent with {@link Span#getSpanContext()}.
*
* @return the {@link SpanContext} of the {@code Span}.
*/
SpanContext getSpanContext();
/**
* Returns the name of the {@code Span}.
*
*
The name can be changed during the lifetime of the Span by using the {@link
* Span#updateName(String)} so this value cannot be cached.
*
* @return the name of the {@code Span}.
*/
String getName();
/**
* This converts this instance into an immutable SpanData instance, for use in export.
*
* @return an immutable {@link SpanData} instance.
*/
SpanData toSpanData();
/**
* Returns the instrumentation library specified when creating the tracer which produced this
* span.
*
* @return an instance of {@link InstrumentationLibraryInfo} describing the instrumentation
* library
*/
InstrumentationLibraryInfo getInstrumentationLibraryInfo();
/**
* Returns whether this Span has already been ended.
*
* @return {@code true} if the span has already been ended, {@code false} if not.
*/
boolean hasEnded();
/**
* Returns the latency of the {@code Span} in nanos. If still active then returns now() - start
* time.
*
* @return the latency of the {@code Span} in nanos.
*/
long getLatencyNanos();
/**
* Returns the kind of the span.
*
* @return the kind of the span.
*/
Span.Kind getKind();
}