org.apache.rocketmq.shaded.io.opentelemetry.sdk.trace.data.SpanData Maven / Gradle / Ivy
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
package org.apache.rocketmq.shaded.io.opentelemetry.sdk.trace.data;
import org.apache.rocketmq.shaded.io.opentelemetry.api.common.Attributes;
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.resources.Resource;
import org.apache.rocketmq.shaded.io.opentelemetry.sdk.trace.SpanLimits;
import java.util.List;
import javax.annotation.concurrent.Immutable;
/**
* Immutable representation of all data collected by the {@link org.apache.rocketmq.shaded.io.opentelemetry.api.trace.Span}
* class.
*/
@Immutable
public interface SpanData {
/**
* Returns the name of this {@code Span}.
*
* @return the name of this {@code Span}.
*/
String getName();
/**
* Returns the kind of this {@code Span}.
*
* @return the kind of this {@code Span}.
*/
SpanKind getKind();
/** Returns the {@link SpanContext} of the Span. */
SpanContext getSpanContext();
/**
* Gets the trace id for this span.
*
* @return the trace id.
*/
default String getTraceId() {
return getSpanContext().getTraceId();
}
/**
* Gets the span id for this span.
*
* @return the span id.
*/
default String getSpanId() {
return getSpanContext().getSpanId();
}
/**
* Returns the parent {@link SpanContext}. If the span is a root span, the {@link SpanContext}
* returned will be invalid.
*/
SpanContext getParentSpanContext();
/**
* Returns the parent {@code SpanId}. If the {@code Span} is a root {@code Span}, the SpanId
* returned will be invalid.
*
* @return the parent {@code SpanId} or an invalid SpanId if this is a root {@code Span}.
*/
default String getParentSpanId() {
return getParentSpanContext().getSpanId();
}
/**
* Returns the {@code Status}.
*
* @return the {@code Status}.
*/
StatusData getStatus();
/**
* Returns the start epoch timestamp in nanos of this {@code Span}.
*
* @return the start epoch timestamp in nanos of this {@code Span}.
*/
long getStartEpochNanos();
/**
* Returns the attributes recorded for this {@code Span}.
*
* @return the attributes recorded for this {@code Span}.
*/
Attributes getAttributes();
/**
* Returns the timed events recorded for this {@code Span}.
*
* @return the timed events recorded for this {@code Span}.
*/
List getEvents();
/**
* Returns links recorded for this {@code Span}.
*
* @return links recorded for this {@code Span}.
*/
List getLinks();
/**
* Returns the end epoch timestamp in nanos of this {@code Span}.
*
* @return the end epoch timestamp in nanos of this {@code Span}.
*/
long getEndEpochNanos();
/**
* Returns whether this Span has already been ended.
*
* @return {@code true} if the span has already been ended, {@code false} if not.
*/
boolean hasEnded();
/**
* The total number of {@link EventData} events that were recorded on this span. This number may
* be larger than the number of events that are attached to this span, if the total number
* recorded was greater than the configured maximum value. See: {@link
* SpanLimits#getMaxNumberOfEvents()}
*
* @return The total number of events recorded on this span.
*/
int getTotalRecordedEvents();
/**
* The total number of {@link LinkData} links that were recorded on this span. This number may be
* larger than the number of links that are attached to this span, if the total number recorded
* was greater than the configured maximum value. See: {@link SpanLimits#getMaxNumberOfLinks()}
*
* @return The total number of links recorded on this span.
*/
int getTotalRecordedLinks();
/**
* The total number of attributes that were recorded on this span. This number may be larger than
* the number of attributes that are attached to this span, if the total number recorded was
* greater than the configured maximum value. See: {@link SpanLimits#getMaxNumberOfAttributes()}
*
* @return The total number of attributes on this span.
*/
int getTotalAttributeCount();
/**
* Returns the instrumentation library specified when creating the tracer which produced this
* {@code Span}.
*
* @return an instance of {@link org.apache.rocketmq.shaded.io.opentelemetry.sdk.common.InstrumentationLibraryInfo}
* @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 {@code
* Span}.
*
* @return an instance of {@link InstrumentationScopeInfo}
*/
InstrumentationScopeInfo getInstrumentationScopeInfo();
/**
* Returns the resource of this {@code Span}.
*
* @return the resource of this {@code Span}.
*/
Resource getResource();
}