org.apache.rocketmq.shaded.io.opentelemetry.sdk.trace.ReadableSpan Maven / Gradle / Ivy
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package org.apache.rocketmq.shaded.io.opentelemetry.sdk.trace;
import org.apache.rocketmq.shaded.io.opentelemetry.api.common.AttributeKey;
import org.apache.rocketmq.shaded.io.opentelemetry.api.trace.Span;
import org.apache.rocketmq.shaded.io.opentelemetry.api.trace.SpanContext;
import org.apache.rocketmq.shaded.io.opentelemetry.api.trace.SpanKind;
import org.apache.rocketmq.shaded.io.opentelemetry.sdk.common.InstrumentationScopeInfo;
import org.apache.rocketmq.shaded.io.opentelemetry.sdk.trace.data.SpanData;
import javax.annotation.Nullable;
/** SDK representation of a {@code Span} that can be read. */
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 parent {@link SpanContext} of the {@code Span}, or {@link SpanContext#getInvalid()}
* if this is a root span.
*
* @return the parent {@link SpanContext} of the {@code Span}
*/
SpanContext getParentSpanContext();
/**
* 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.
*
*
Note: the implementation of this method performs locking to ensure thread-safe behavior.
*
* @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 org.apache.rocketmq.shaded.io.opentelemetry.sdk.common.InstrumentationLibraryInfo}
* describing the instrumentation library
* @deprecated Use {@link #getInstrumentationScopeInfo()}.
*/
@Deprecated
org.apache.rocketmq.shaded.io.opentelemetry.sdk.common.InstrumentationLibraryInfo getInstrumentationLibraryInfo();
/**
* Returns the instrumentation scope specified when creating the tracer which produced this span.
*
* @return an instance of {@link InstrumentationScopeInfo} describing the instrumentation scope
*/
InstrumentationScopeInfo getInstrumentationScopeInfo();
/**
* Returns whether this Span has already been ended.
*
*
Note: the implementation of this method performs locking to ensure thread-safe behavior.
*
* @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.
*
*
Note: the implementation of this method performs locking to ensure thread-safe behavior.
*
* @return the latency of the {@code Span} in nanos.
*/
long getLatencyNanos();
/**
* Returns the kind of the span.
*
* @return the kind of the span.
*/
SpanKind getKind();
/**
* Returns the value for the given {@link AttributeKey}, or {@code null} if not found.
*
*
The attribute values can be changed during the lifetime of the Span by using {@link
* Span#setAttribute}} so this value cannot be cached.
*
*
Note: the implementation of this method performs locking to ensure thread-safe behavior.
*
* @return the value for the given {@link AttributeKey}, or {@code null} if not found.
*/
@Nullable
T getAttribute(AttributeKey key);
}