A B C D E F G H I L M N O P R S T U V W

A

ABORTED - Static variable in class io.opencensus.trace.Status

The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.

addAnnotation(String, Map<String, AttributeValue>) - Method in class io.opencensus.trace.BlankSpan

No-op implementation of the Span.addAnnotation(String, Map) method.

addAnnotation(Annotation) - Method in class io.opencensus.trace.BlankSpan

No-op implementation of the Span.addAnnotation(Annotation) method.

addAnnotation(String) - Method in class io.opencensus.trace.Span

Adds an annotation to the Span.

addAnnotation(String, Map<String, AttributeValue>) - Method in class io.opencensus.trace.Span

Adds an annotation to the Span.

addAnnotation(Annotation) - Method in class io.opencensus.trace.Span

Adds an annotation to the Span.

addAttributes(Map<String, AttributeValue>) - Method in class io.opencensus.trace.Span

Deprecated.

Use Span.putAttributes(Map)

addDuration(Duration) - Method in class io.opencensus.common.Timestamp

Returns a Timestamp calculated as this Timestamp plus some Duration.

addLink(Link) - Method in class io.opencensus.trace.BlankSpan

No-op implementation of the Span.addLink(Link) method.

addLink(Link) - Method in class io.opencensus.trace.Span

Adds a Link to the Span.

addNanos(long) - Method in class io.opencensus.common.Timestamp

Returns a Timestamp calculated as this Timestamp plus some number of nanoseconds.

addNetworkEvent(NetworkEvent) - Method in class io.opencensus.trace.BlankSpan

No-op implementation of the Span.addNetworkEvent(NetworkEvent) method.

addNetworkEvent(NetworkEvent) - Method in class io.opencensus.trace.Span

Adds a NetworkEvent to the Span.

Aggregation - Class in io.opencensus.stats

Aggregation is the process of combining a certain set of MeasureValues for a given Measure into an AggregationData.

Aggregation.Count - Class in io.opencensus.stats

Calculate count on aggregated MeasureValues.

Aggregation.Distribution - Class in io.opencensus.stats

Calculate distribution stats on aggregated MeasureValues.

Aggregation.Mean - Class in io.opencensus.stats

Calculate mean on aggregated MeasureValues.

Aggregation.Sum - Class in io.opencensus.stats

Calculate sum on aggregated MeasureValues.

AggregationData - Class in io.opencensus.stats

AggregationData is the result of applying a given Aggregation to a set of MeasureValues.

AggregationData.CountData - Class in io.opencensus.stats

The count value of aggregated MeasureValues.

AggregationData.DistributionData - Class in io.opencensus.stats

The distribution stats of aggregated MeasureValues.

AggregationData.MeanData - Class in io.opencensus.stats

The mean value of aggregated MeasureValues.

AggregationData.SumDataDouble - Class in io.opencensus.stats

The sum value of aggregated MeasureValueDoubles.

AggregationData.SumDataLong - Class in io.opencensus.stats

The sum value of aggregated MeasureValueLongs.

ALREADY_EXISTS - Static variable in class io.opencensus.trace.Status

Some entity that we attempted to create (e.g., file or directory) already exists.

alwaysSample() - Static method in class io.opencensus.trace.samplers.Samplers

Returns a Sampler that always makes a "yes" decision on Span sampling.

Annotation - Class in io.opencensus.trace

A text annotation with a set of attributes.

apply(A) - Method in interface io.opencensus.common.Function

asString() - Method in class io.opencensus.stats.View.Name

Returns the name as a String.

asString() - Method in class io.opencensus.tags.TagValue

Returns the tag value as a String.

AttributeValue - Class in io.opencensus.trace

A class that represents all the possible values for an attribute.

B

BinaryFormat - Class in io.opencensus.trace.propagation

This is a helper class for SpanContext propagation on the wire using binary encoding.

BinaryFormat() - Constructor for class io.opencensus.trace.propagation.BinaryFormat

BlankSpan - Class in io.opencensus.trace

The BlankSpan is a singleton class, which is the default Span that is used when no Span implementation is available.

booleanAttributeValue(boolean) - Static method in class io.opencensus.trace.AttributeValue

Returns an AttributeValue with a boolean value.

BucketBoundaries - Class in io.opencensus.stats

The bucket boundaries for a histogram.

BucketBoundaries() - Constructor for class io.opencensus.stats.BucketBoundaries

build() - Method in class io.opencensus.tags.TagContextBuilder

Creates a TagContext from this builder.

build() - Method in class io.opencensus.trace.config.TraceParams.Builder

Builds and returns a TraceParams with the desired values.

build() - Method in class io.opencensus.trace.EndSpanOptions.Builder

Builds and returns a EndSpanOptions with the desired settings.

build() - Method in class io.opencensus.trace.NetworkEvent.Builder

Builds and returns a NetworkEvent with the desired values.

build() - Method in class io.opencensus.trace.TraceOptions.Builder

Builds and returns a TraceOptions with the desired options.

Builder() - Constructor for class io.opencensus.trace.config.TraceParams.Builder

builder() - Static method in class io.opencensus.trace.EndSpanOptions

Returns a new EndSpanOptions.Builder with default options.

builder(NetworkEvent.Type, long) - Static method in class io.opencensus.trace.NetworkEvent

Returns a new NetworkEvent.Builder with default values.

builder() - Static method in class io.opencensus.trace.TraceOptions

Returns a new TraceOptions.Builder with default options.

builder(TraceOptions) - Static method in class io.opencensus.trace.TraceOptions

Returns a new TraceOptions.Builder with all given options set.

buildScoped() - Method in class io.opencensus.tags.TagContextBuilder

Enters the scope of code where the TagContext created from this builder is in the current context and returns an object that represents that scope.

C

CANCELLED - Static variable in class io.opencensus.trace.Status

The operation was cancelled (typically by the caller).

Clock - Class in io.opencensus.common

Interface for getting the current time.

Clock() - Constructor for class io.opencensus.common.Clock

close() - Method in interface io.opencensus.common.NonThrowingCloseable

Deprecated.

close() - Method in interface io.opencensus.common.Scope

compareTo(Duration) - Method in class io.opencensus.common.Duration

Compares this Duration to the specified Duration.

compareTo(Timestamp) - Method in class io.opencensus.common.Timestamp

Compares this Timestamp to the specified Timestamp.

compareTo(SpanId) - Method in class io.opencensus.trace.SpanId

compareTo(TraceId) - Method in class io.opencensus.trace.TraceId

CONTEXT_SPAN_KEY - Static variable in class io.opencensus.trace.unsafe.ContextUtils

The Context.Key used to interact with Context.

ContextUtils - Class in io.opencensus.tags.unsafe

Utility methods for accessing the TagContext contained in the Context.

ContextUtils - Class in io.opencensus.trace.unsafe

Util methods/functionality to interact with the Context.

copyBytesTo(byte[], int) - Method in class io.opencensus.trace.SpanId

Copies the byte array representations of the SpanId into the dest beginning at the destOffset offset.

copyBytesTo(byte[], int) - Method in class io.opencensus.trace.TraceId

Copies the byte array representations of the TraceId into the dest beginning at the destOffset offset.

copyBytesTo(byte[], int) - Method in class io.opencensus.trace.TraceOptions

Copies the byte representations of the TraceOptions into the dest beginning at the destOffset offset.

create(long, int) - Static method in class io.opencensus.common.Duration

Creates a new time duration from given seconds and nanoseconds.

create(long, int) - Static method in class io.opencensus.common.Timestamp

Creates a new timestamp from given seconds and nanoseconds.

create() - Static method in class io.opencensus.stats.Aggregation.Count

Construct a Count.

create(BucketBoundaries) - Static method in class io.opencensus.stats.Aggregation.Distribution

Construct a Distribution.

create() - Static method in class io.opencensus.stats.Aggregation.Mean

Construct a Mean.

create() - Static method in class io.opencensus.stats.Aggregation.Sum

Construct a Sum.

create(long) - Static method in class io.opencensus.stats.AggregationData.CountData

Creates a CountData.

create(double, long, double, double, double, List<Long>) - Static method in class io.opencensus.stats.AggregationData.DistributionData

Creates a DistributionData.

create(double, long) - Static method in class io.opencensus.stats.AggregationData.MeanData

Creates a MeanData.

create(double) - Static method in class io.opencensus.stats.AggregationData.SumDataDouble

Creates a SumDataDouble.

create(long) - Static method in class io.opencensus.stats.AggregationData.SumDataLong

Creates a SumDataLong.

create(List<Double>) - Static method in class io.opencensus.stats.BucketBoundaries

create(String, String, String) - Static method in class io.opencensus.stats.Measure.MeasureDouble

Constructs a new Measure.MeasureDouble.

create(String, String, String) - Static method in class io.opencensus.stats.Measure.MeasureLong

Constructs a new Measure.MeasureLong.

create(Measure.MeasureDouble, double) - Static method in class io.opencensus.stats.Measurement.MeasurementDouble

Constructs a new Measurement.MeasurementDouble.

create(Measure.MeasureLong, long) - Static method in class io.opencensus.stats.Measurement.MeasurementLong

Constructs a new Measurement.MeasurementLong.

create() - Static method in class io.opencensus.stats.View.AggregationWindow.Cumulative

Constructs a cumulative AggregationWindow that does not have an explicit Duration.

create(Duration) - Static method in class io.opencensus.stats.View.AggregationWindow.Interval

Constructs an interval AggregationWindow that has a finite explicit Duration.

create(View.Name, String, Measure, Aggregation, List<TagKey>, View.AggregationWindow) - Static method in class io.opencensus.stats.View

Constructs a new View.

create(String) - Static method in class io.opencensus.stats.View.Name

Creates a View.Name from a String.

create(Timestamp, Timestamp) - Static method in class io.opencensus.stats.ViewData.AggregationWindowData.CumulativeData

Constructs a new ViewData.AggregationWindowData.CumulativeData.

create(Timestamp) - Static method in class io.opencensus.stats.ViewData.AggregationWindowData.IntervalData

Constructs a new ViewData.AggregationWindowData.IntervalData.

create(View, Map<? extends List<TagValue>, ? extends AggregationData>, ViewData.AggregationWindowData) - Static method in class io.opencensus.stats.ViewData

Constructs a new ViewData.

create(TagKey, TagValue) - Static method in class io.opencensus.tags.Tag

Creates a Tag from the given key and value.

create(String) - Static method in class io.opencensus.tags.TagKey

Constructs a TagKey with the given name.

create(String) - Static method in class io.opencensus.tags.TagValue

Constructs a TagValue from the given string.

create(String, int) - Static method in class io.opencensus.trace.export.RunningSpanStore.Filter

Returns a new instance of Filter.

create(int) - Static method in class io.opencensus.trace.export.RunningSpanStore.PerSpanNameSummary

Returns a new instance of PerSpanNameSummary.

create(Map<String, RunningSpanStore.PerSpanNameSummary>) - Static method in class io.opencensus.trace.export.RunningSpanStore.Summary

Returns a new instance of Summary.

create(String, Status.CanonicalCode, int) - Static method in class io.opencensus.trace.export.SampledSpanStore.ErrorFilter

Returns a new instance of ErrorFilter.

create(String, long, long, int) - Static method in class io.opencensus.trace.export.SampledSpanStore.LatencyFilter

Returns a new instance of LatencyFilter.

create(Map<SampledSpanStore.LatencyBucketBoundaries, Integer>, Map<Status.CanonicalCode, Integer>) - Static method in class io.opencensus.trace.export.SampledSpanStore.PerSpanNameSummary

Returns a new instance of PerSpanNameSummary.

create(Map<String, SampledSpanStore.PerSpanNameSummary>) - Static method in class io.opencensus.trace.export.SampledSpanStore.Summary

Returns a new instance of Summary.

create(Map<String, AttributeValue>, int) - Static method in class io.opencensus.trace.export.SpanData.Attributes

Returns a new immutable Attributes.

create(SpanContext, SpanId, Boolean, String, Timestamp, SpanData.Attributes, SpanData.TimedEvents<Annotation>, SpanData.TimedEvents<NetworkEvent>, SpanData.Links, Integer, Status, Timestamp) - Static method in class io.opencensus.trace.export.SpanData

Returns a new immutable SpanData.

create(List<Link>, int) - Static method in class io.opencensus.trace.export.SpanData.Links

Returns a new immutable Links.

create(Timestamp, T) - Static method in class io.opencensus.trace.export.SpanData.TimedEvent

Returns a new immutable TimedEvent<T>.

create(List<SpanData.TimedEvent<T>>, int) - Static method in class io.opencensus.trace.export.SpanData.TimedEvents

Returns a new immutable TimedEvents<T>.

create(TraceId, SpanId, TraceOptions) - Static method in class io.opencensus.trace.SpanContext

Creates a new SpanContext with the given identifiers and options.

currentBuilder() - Method in class io.opencensus.tags.Tagger

Returns a new builder created from the current TagContext.

D

DATA_LOSS - Static variable in class io.opencensus.trace.Status

Unrecoverable data loss or corruption.

DEADLINE_EXCEEDED - Static variable in class io.opencensus.trace.Status

Deadline expired before operation could complete.

DEFAULT - Static variable in class io.opencensus.trace.config.TraceParams

DEFAULT - Static variable in class io.opencensus.trace.EndSpanOptions

The default EndSpanOptions.

DEFAULT - Static variable in class io.opencensus.trace.TraceOptions

The default TraceOptions.

Duration - Class in io.opencensus.common

Represents a signed, fixed-length span of time represented as a count of seconds and fractions of seconds at nanosecond resolution.

E

empty() - Method in class io.opencensus.tags.Tagger

Returns an empty TagContext.

emptyBuilder() - Method in class io.opencensus.tags.Tagger

Returns a new empty Builder.

end(EndSpanOptions) - Method in class io.opencensus.trace.BlankSpan

No-op implementation of the Span.end(EndSpanOptions) method.

end(EndSpanOptions) - Method in class io.opencensus.trace.Span

Marks the end of Span execution with the given options.

end() - Method in class io.opencensus.trace.Span

Marks the end of Span execution with the default options.

EndSpanOptions - Class in io.opencensus.trace

A class that enables overriding the default values used when ending a Span.

EndSpanOptions.Builder - Class in io.opencensus.trace

Builder class for EndSpanOptions.

equals(Object) - Method in class io.opencensus.tags.TagContext

Returns true iff the other object is an instance of TagContext and contains the same key-value pairs.

equals(Object) - Method in class io.opencensus.trace.SpanContext

equals(Object) - Method in class io.opencensus.trace.SpanId

equals(Object) - Method in class io.opencensus.trace.Status

Equality on Statuses is not well defined.

equals(Object) - Method in class io.opencensus.trace.TraceId

equals(Object) - Method in class io.opencensus.trace.TraceOptions

ExperimentalApi - Annotation Type in io.opencensus.common

Indicates a public API that can change at any time, and has no guarantee of API stability and backward-compatibility.

export(Collection<SpanData>) - Method in class io.opencensus.trace.export.SpanExporter.Handler

Exports a list of sampled (see TraceOptions.isSampled()) Spans using the immutable representation SpanData.

ExportComponent - Class in io.opencensus.trace.export

Class that holds the implementation instances for SpanExporter, RunningSpanStore and SampledSpanStore.

ExportComponent() - Constructor for class io.opencensus.trace.export.ExportComponent

F

FAILED_PRECONDITION - Static variable in class io.opencensus.trace.Status

Operation was rejected because the system is not in a state required for the operation's execution.

fromBinaryValue(byte[]) - Method in class io.opencensus.trace.propagation.BinaryFormat

Deprecated.

use BinaryFormat.fromByteArray(byte[]).

fromByteArray(byte[]) - Method in class io.opencensus.tags.propagation.TagContextBinarySerializer

Creates a TagContext from the given on-the-wire encoded representation.

fromByteArray(byte[]) - Method in class io.opencensus.trace.propagation.BinaryFormat

Parses the SpanContext from a byte array using the binary format.

fromBytes(byte[]) - Static method in class io.opencensus.trace.SpanId

Returns a SpanId built from a byte representation.

fromBytes(byte[], int) - Static method in class io.opencensus.trace.SpanId

Returns a SpanId whose representation is copied from the src beginning at the srcOffset offset.

fromBytes(byte[]) - Static method in class io.opencensus.trace.TraceId

Returns a TraceId built from a byte representation.

fromBytes(byte[], int) - Static method in class io.opencensus.trace.TraceId

Returns a TraceId whose representation is copied from the src beginning at the srcOffset offset.

fromBytes(byte[]) - Static method in class io.opencensus.trace.TraceOptions

Returns a TraceOptions built from a byte representation.

fromBytes(byte[], int) - Static method in class io.opencensus.trace.TraceOptions

Returns a TraceOptions whose representation is copied from the src beginning at the srcOffset offset.

fromDescription(String) - Static method in class io.opencensus.trace.Annotation

Returns a new Annotation with the given description.

fromDescriptionAndAttributes(String, Map<String, AttributeValue>) - Static method in class io.opencensus.trace.Annotation

Returns a new Annotation with the given description and set of attributes.

fromMillis(long) - Static method in class io.opencensus.common.Duration

Creates a new Duration from given milliseconds.

fromMillis(long) - Static method in class io.opencensus.common.Timestamp

Creates a new timestamp from the given milliseconds.

fromSpanContext(SpanContext, Link.Type) - Static method in class io.opencensus.trace.Link

Returns a new Link.

fromSpanContext(SpanContext, Link.Type, Map<String, AttributeValue>) - Static method in class io.opencensus.trace.Link

Returns a new Link.

Function<A,B> - Interface in io.opencensus.common

Used to specify matching functions for use encoding tagged unions (i.e.

Functions - Class in io.opencensus.common

Commonly used Function instances.

G

generateRandomId(Random) - Static method in class io.opencensus.trace.SpanId

Generates a new random SpanId.

generateRandomId(Random) - Static method in class io.opencensus.trace.TraceId

Generates a new random TraceId.

getActiveTraceParams() - Method in class io.opencensus.trace.config.TraceConfig

Returns the active TraceParams.

getAggregation() - Method in class io.opencensus.stats.View

The Aggregation associated with this View.

getAggregationMap() - Method in class io.opencensus.stats.ViewData

The AggregationData grouped by combination of tag values, associated with this ViewData.

getAllExportedViews() - Method in class io.opencensus.stats.ViewManager

Returns all registered views that should be exported.

getAnnotations() - Method in class io.opencensus.trace.export.SpanData

Returns the annotations recorded for this Span.

getAttributeMap() - Method in class io.opencensus.trace.export.SpanData.Attributes

Returns the set of attributes.

getAttributes() - Method in class io.opencensus.trace.Annotation

Return the attributes of the Annotation.

getAttributes() - Method in class io.opencensus.trace.export.SpanData

Returns the attributes recorded for this Span.

getAttributes() - Method in class io.opencensus.trace.Link

Returns the set of attributes.

getBinaryFormat() - Method in class io.opencensus.trace.propagation.PropagationComponent

Returns the BinaryFormat with the provided implementations.

getBinarySerializer() - Method in class io.opencensus.tags.propagation.TagPropagationComponent

Returns the TagContextBinarySerializer for this implementation.

getBoundaries() - Method in class io.opencensus.stats.BucketBoundaries

Returns a list of histogram bucket boundaries.

getBucketBoundaries() - Method in class io.opencensus.stats.Aggregation.Distribution

getBucketCounts() - Method in class io.opencensus.stats.AggregationData.DistributionData

Returns the aggregated bucket counts.

getBytes() - Method in class io.opencensus.trace.SpanId

Returns the byte representation of the SpanId.

getBytes() - Method in class io.opencensus.trace.TraceId

Returns the 16-bytes array representation of the TraceId.

getBytes() - Method in class io.opencensus.trace.TraceOptions

Returns the 1-byte array representation of the TraceOptions.

getCanonicalCode() - Method in class io.opencensus.trace.export.SampledSpanStore.ErrorFilter

Returns the canonical code used by this filter.

getCanonicalCode() - Method in class io.opencensus.trace.Status

Returns the canonical status code.

getChildSpanCount() - Method in class io.opencensus.trace.export.SpanData

Returns the number of child spans that were generated while the Span was running.

getClock() - Method in class io.opencensus.trace.TraceComponent

Returns the Clock with the provided implementation.

getClock() - Static method in class io.opencensus.trace.Tracing

Returns the global Clock.

getColumns() - Method in class io.opencensus.stats.View

Columns (a.k.a Tag Keys) to match with the associated Measure.

getCompressedMessageSize() - Method in class io.opencensus.trace.NetworkEvent

Returns the compressed size in bytes of the NetworkEvent.

getContext() - Method in class io.opencensus.trace.export.SpanData

Returns the SpanContext associated with this Span.

getContext() - Method in class io.opencensus.trace.Span

Returns the SpanContext associated with this Span.

getCount() - Method in class io.opencensus.stats.AggregationData.CountData

Returns the aggregated count.

getCount() - Method in class io.opencensus.stats.AggregationData.DistributionData

Returns the aggregated count.

getCount() - Method in class io.opencensus.stats.AggregationData.MeanData

Returns the aggregated count.

getCurrentSpan() - Method in class io.opencensus.trace.Tracer

Gets the current Span from the current Context.

getCurrentTagContext() - Method in class io.opencensus.tags.Tagger

Returns the current TagContext.

getDescription() - Method in class io.opencensus.stats.Measure

Detailed description of the measure, used in documentation.

getDescription() - Method in class io.opencensus.stats.Measure.MeasureDouble

getDescription() - Method in class io.opencensus.stats.Measure.MeasureLong

getDescription() - Method in class io.opencensus.stats.View

More detailed description, for documentation purposes.

getDescription() - Method in class io.opencensus.trace.Annotation

Return the description of the Annotation.

getDescription() - Method in class io.opencensus.trace.Sampler

Returns the description of this Sampler.

getDescription() - Method in class io.opencensus.trace.Status

Returns the description of this Status for human consumption.

getDroppedAttributesCount() - Method in class io.opencensus.trace.export.SpanData.Attributes

Returns the number of dropped attributes.

getDroppedEventsCount() - Method in class io.opencensus.trace.export.SpanData.TimedEvents

Returns the number of dropped events.

getDroppedLinksCount() - Method in class io.opencensus.trace.export.SpanData.Links

Returns the number of dropped links.

getDuration() - Method in class io.opencensus.stats.View.AggregationWindow.Interval

Returns the Duration associated with this Interval.

getEnd() - Method in class io.opencensus.stats.ViewData.AggregationWindowData.CumulativeData

Returns the end Timestamp for a ViewData.AggregationWindowData.CumulativeData.

getEnd() - Method in class io.opencensus.stats.ViewData.AggregationWindowData.IntervalData

Returns the end Timestamp for an ViewData.AggregationWindowData.IntervalData.

getEndTimestamp() - Method in class io.opencensus.trace.export.SpanData

Returns the end Timestamp or null if the Span is still active.

getErrorSampledSpans(SampledSpanStore.ErrorFilter) - Method in class io.opencensus.trace.export.SampledSpanStore

Returns a list of failed spans (spans with Status other than Status.OK) that match the filter.

getEvent() - Method in class io.opencensus.trace.export.SpanData.TimedEvent

Returns the event.

getEvents() - Method in class io.opencensus.trace.export.SpanData.TimedEvents

Returns the list of events.

getExportComponent() - Method in class io.opencensus.trace.TraceComponent

Returns the ExportComponent with the provided implementation.

getExportComponent() - Static method in class io.opencensus.trace.Tracing

Returns the global ExportComponent.

getHasRemoteParent() - Method in class io.opencensus.trace.export.SpanData

Returns true if the parent is on a different process.

getIterator() - Method in class io.opencensus.tags.TagContext

Returns an iterator over the tags in this TagContext.

getKernelTimestamp() - Method in class io.opencensus.trace.NetworkEvent

Returns the kernel timestamp associated with the NetworkEvent or null if not set.

getKey() - Method in class io.opencensus.tags.Tag

Returns the tag's key.

getLatencyLowerNs() - Method in enum io.opencensus.trace.export.SampledSpanStore.LatencyBucketBoundaries

Returns the latency lower bound of the bucket.

getLatencyLowerNs() - Method in class io.opencensus.trace.export.SampledSpanStore.LatencyFilter

Returns the latency lower bound of this bucket (inclusive).

getLatencySampledSpans(SampledSpanStore.LatencyFilter) - Method in class io.opencensus.trace.export.SampledSpanStore

Returns a list of succeeded spans (spans with Status equal to Status.OK) that match the filter.

getLatencyUpperNs() - Method in enum io.opencensus.trace.export.SampledSpanStore.LatencyBucketBoundaries

Returns the latency upper bound of the bucket.

getLatencyUpperNs() - Method in class io.opencensus.trace.export.SampledSpanStore.LatencyFilter

Returns the latency upper bound of this bucket (exclusive).

getLinks() - Method in class io.opencensus.trace.export.SpanData

Returns links recorded for this Span.

getLinks() - Method in class io.opencensus.trace.export.SpanData.Links

Returns the list of links.

getLowerLong() - Method in class io.opencensus.trace.TraceId

Returns the lower 8 bytes of the trace-id as a long value, assuming little-endian order.

getMax() - Method in class io.opencensus.stats.AggregationData.DistributionData

Returns the maximum of the population values.

getMaxNumberOfAnnotations() - Method in class io.opencensus.trace.config.TraceParams

Returns the global default max number of Annotation events per Span.

getMaxNumberOfAttributes() - Method in class io.opencensus.trace.config.TraceParams

Returns the global default max number of attributes per Span.

getMaxNumberOfLinks() - Method in class io.opencensus.trace.config.TraceParams

Returns the global default max number of Link entries per Span.

getMaxNumberOfNetworkEvents() - Method in class io.opencensus.trace.config.TraceParams

Returns the global default max number of NetworkEvent events per Span.

getMaxSpansToReturn() - Method in class io.opencensus.trace.export.RunningSpanStore.Filter

Returns the maximum number of spans to be returned.

getMaxSpansToReturn() - Method in class io.opencensus.trace.export.SampledSpanStore.ErrorFilter

Returns the maximum number of spans to be returned.

getMaxSpansToReturn() - Method in class io.opencensus.trace.export.SampledSpanStore.LatencyFilter

Returns the maximum number of spans to be returned.

getMean() - Method in class io.opencensus.stats.AggregationData.DistributionData

Returns the aggregated mean.

getMean() - Method in class io.opencensus.stats.AggregationData.MeanData

Returns the aggregated mean.

getMeasure() - Method in class io.opencensus.stats.Measurement

Extracts the measured Measure.

getMeasure() - Method in class io.opencensus.stats.Measurement.MeasurementDouble

getMeasure() - Method in class io.opencensus.stats.Measurement.MeasurementLong

getMeasure() - Method in class io.opencensus.stats.View

Measure type of this view.

getMessageId() - Method in class io.opencensus.trace.NetworkEvent

Returns the message id argument that serves to uniquely identify each network message.

getMessageSize() - Method in class io.opencensus.trace.NetworkEvent

Deprecated.

Use NetworkEvent.getUncompressedMessageSize().

getMin() - Method in class io.opencensus.stats.AggregationData.DistributionData

Returns the minimum of the population values.

getName() - Method in class io.opencensus.stats.Measure

Name of measure, as a String.

getName() - Method in class io.opencensus.stats.Measure.MeasureDouble

getName() - Method in class io.opencensus.stats.Measure.MeasureLong

getName() - Method in class io.opencensus.stats.View

Name of view.

getName() - Method in class io.opencensus.tags.TagKey

Returns the name of the key.

getName() - Method in class io.opencensus.trace.export.SpanData

Returns the name of this Span.

getNanos() - Method in class io.opencensus.common.Duration

Returns the number of nanoseconds in the Duration.

getNanos() - Method in class io.opencensus.common.Timestamp

Returns the number of nanoseconds after the number of seconds since the Unix Epoch represented by this timestamp.

getNetworkEvents() - Method in class io.opencensus.trace.export.SpanData

Returns network events recorded for this Span.

getNoopPropagationComponent() - Static method in class io.opencensus.trace.propagation.PropagationComponent

Returns an instance that contains no-op implementations for all the instances.

getNoopSpanExporter() - Static method in class io.opencensus.trace.export.SpanExporter

Returns the no-op implementation of the ExportComponent.

getNoopTraceConfig() - Static method in class io.opencensus.trace.config.TraceConfig

Returns the no-op implementation of the TraceConfig.

getNumbersOfErrorSampledSpans() - Method in class io.opencensus.trace.export.SampledSpanStore.PerSpanNameSummary

Returns the number of sampled spans in all the error buckets.

getNumbersOfLatencySampledSpans() - Method in class io.opencensus.trace.export.SampledSpanStore.PerSpanNameSummary

Returns the number of sampled spans in all the latency buckets.

getNumRunningSpans() - Method in class io.opencensus.trace.export.RunningSpanStore.PerSpanNameSummary

Returns the number of running spans.

getOptions() - Method in class io.opencensus.trace.Span

Returns the options associated with this Span.

getParentSpanId() - Method in class io.opencensus.trace.export.SpanData

Returns the parent SpanId or null if the Span is a root Span.

getPerSpanNameSummary() - Method in class io.opencensus.trace.export.RunningSpanStore.Summary

Returns a map with summary of available data for each span name.

getPerSpanNameSummary() - Method in class io.opencensus.trace.export.SampledSpanStore.Summary

Returns a map with summary of available data for each span name.

getPropagationComponent() - Method in class io.opencensus.trace.TraceComponent

Returns the PropagationComponent with the provided implementation.

getPropagationComponent() - Static method in class io.opencensus.trace.Tracing

Returns the global PropagationComponent.

getRegisteredSpanNamesForCollection() - Method in class io.opencensus.trace.export.SampledSpanStore

Returns the set of unique span names registered to the library.

getRunningSpans(RunningSpanStore.Filter) - Method in class io.opencensus.trace.export.RunningSpanStore

Returns a list of running spans that match the Filter.

getRunningSpanStore() - Method in class io.opencensus.trace.export.ExportComponent

Returns the RunningSpanStore that can be used to get useful debugging information about all the current active spans.

getSampledSpanStore() - Method in class io.opencensus.trace.export.ExportComponent

Returns the SampledSpanStore that can be used to get useful debugging information, such as latency based sampled spans, error based sampled spans.

getSampler() - Method in class io.opencensus.trace.config.TraceParams

Returns the global default Sampler.

getSampleToLocalSpanStore() - Method in class io.opencensus.trace.EndSpanOptions

If true this is equivalent with calling the SampledSpanStore.registerSpanNamesForCollection(Collection) in advance for this span name.

getSeconds() - Method in class io.opencensus.common.Duration

Returns the number of seconds in the Duration.

getSeconds() - Method in class io.opencensus.common.Timestamp

Returns the number of seconds since the Unix Epoch represented by this timestamp.

getSpanExporter() - Method in class io.opencensus.trace.export.ExportComponent

Returns the SpanExporter which can be used to register handlers to export all the spans that are part of a distributed sampled trace (see TraceOptions.isSampled()).

getSpanId() - Method in class io.opencensus.trace.Link

Returns the SpanId.

getSpanId() - Method in class io.opencensus.trace.SpanContext

Returns the span identifier associated with this SpanContext.

getSpanName() - Method in class io.opencensus.trace.export.RunningSpanStore.Filter

Returns the span name.

getSpanName() - Method in class io.opencensus.trace.export.SampledSpanStore.ErrorFilter

Returns the span name used by this filter.

getSpanName() - Method in class io.opencensus.trace.export.SampledSpanStore.LatencyFilter

Returns the span name used by this filter.

getStart() - Method in class io.opencensus.stats.ViewData.AggregationWindowData.CumulativeData

Returns the start Timestamp for a ViewData.AggregationWindowData.CumulativeData.

getStartTimestamp() - Method in class io.opencensus.trace.export.SpanData

Returns the start Timestamp of this Span.

getState() - Static method in class io.opencensus.stats.Stats

Returns the current StatsCollectionState.

getState() - Method in class io.opencensus.stats.StatsComponent

Returns the current StatsCollectionState.

getState() - Static method in class io.opencensus.tags.Tags

Returns the current TaggingState.

getState() - Method in class io.opencensus.tags.TagsComponent

Returns the current TaggingState.

getStatsRecorder() - Static method in class io.opencensus.stats.Stats

Returns the default StatsRecorder.

getStatsRecorder() - Method in class io.opencensus.stats.StatsComponent

Returns the default StatsRecorder.

getStatus() - Method in class io.opencensus.trace.EndSpanOptions

Returns the status.

getStatus() - Method in class io.opencensus.trace.export.SpanData

Returns the Status or null if Span is still active.

getSum() - Method in class io.opencensus.stats.AggregationData.SumDataDouble

Returns the aggregated sum.

getSum() - Method in class io.opencensus.stats.AggregationData.SumDataLong

Returns the aggregated sum.

getSummary() - Method in class io.opencensus.trace.export.RunningSpanStore

Returns the summary of all available data such, as number of running spans.

getSummary() - Method in class io.opencensus.trace.export.SampledSpanStore

Returns the summary of all available data, such as number of sampled spans in the latency based samples or error based samples.

getSumOfSquaredDeviations() - Method in class io.opencensus.stats.AggregationData.DistributionData

Returns the aggregated sum of squared deviations.

getTagger() - Static method in class io.opencensus.tags.Tags

Returns the default Tagger.

getTagger() - Method in class io.opencensus.tags.TagsComponent

Returns the Tagger for this implementation.

getTagPropagationComponent() - Static method in class io.opencensus.tags.Tags

Returns the default TagPropagationComponent.

getTagPropagationComponent() - Method in class io.opencensus.tags.TagsComponent

Returns the TagPropagationComponent for this implementation.

getTags(TagContext) - Static method in class io.opencensus.tags.InternalUtils

getTimestamp() - Method in class io.opencensus.trace.export.SpanData.TimedEvent

Returns the Timestamp of this event.

getTraceConfig() - Method in class io.opencensus.trace.TraceComponent

Returns the TraceConfig with the provided implementation.

getTraceConfig() - Static method in class io.opencensus.trace.Tracing

Returns the global TraceConfig.

getTraceId() - Method in class io.opencensus.trace.Link

Returns the TraceId.

getTraceId() - Method in class io.opencensus.trace.SpanContext

Returns the trace identifier associated with this SpanContext.

getTraceOptions() - Method in class io.opencensus.trace.SpanContext

Returns the trace options associated with this SpanContext.

getTracer() - Method in class io.opencensus.trace.TraceComponent

Returns the Tracer with the provided implementations.

getTracer() - Static method in class io.opencensus.trace.Tracing

Returns the global Tracer.

getType() - Method in class io.opencensus.trace.Link

Returns the Type.

getType() - Method in class io.opencensus.trace.NetworkEvent

Returns the type of the NetworkEvent.

getUncompressedMessageSize() - Method in class io.opencensus.trace.NetworkEvent

Returns the uncompressed size in bytes of the NetworkEvent.

getUnit() - Method in class io.opencensus.stats.Measure

The units in which Measure values are measured.

getUnit() - Method in class io.opencensus.stats.Measure.MeasureDouble

getUnit() - Method in class io.opencensus.stats.Measure.MeasureLong

getValue() - Method in class io.opencensus.stats.Measurement.MeasurementDouble

getValue() - Method in class io.opencensus.stats.Measurement.MeasurementLong

getValue() - Method in class io.opencensus.tags.Tag

Returns the tag's value.

getView() - Method in class io.opencensus.stats.ViewData

The View associated with this ViewData.

getView(View.Name) - Method in class io.opencensus.stats.ViewManager

Returns the current stats data, ViewData, associated with the given view name.

getViewManager() - Static method in class io.opencensus.stats.Stats

Returns the default ViewManager.

getViewManager() - Method in class io.opencensus.stats.StatsComponent

Returns the default ViewManager.

getWindow() - Method in class io.opencensus.stats.View

Returns the time View.AggregationWindow for this View.

getWindowData() - Method in class io.opencensus.stats.ViewData

Returns the ViewData.AggregationWindowData associated with this ViewData.

H

Handler() - Constructor for class io.opencensus.trace.export.SpanExporter.Handler

hashCode() - Method in class io.opencensus.tags.TagContext

hashCode() - Method in class io.opencensus.trace.SpanContext

hashCode() - Method in class io.opencensus.trace.SpanId

hashCode() - Method in class io.opencensus.trace.Status

Hash codes on Statuses are not well defined.

hashCode() - Method in class io.opencensus.trace.TraceId

hashCode() - Method in class io.opencensus.trace.TraceOptions

I

INSTANCE - Static variable in class io.opencensus.trace.BlankSpan

Singleton instance of this class.

Internal - Annotation Type in io.opencensus.common

Annotates a program element (class, method, package etc) which is internal to OpenCensus, not part of the public API, and should not be used by users of the OpenCensus library.

INTERNAL - Static variable in class io.opencensus.trace.Status

Internal errors.

InternalUtils - Class in io.opencensus.tags

Internal tagging utilities.

INVALID - Static variable in class io.opencensus.trace.SpanContext

The invalid SpanContext.

INVALID - Static variable in class io.opencensus.trace.SpanId

The invalid SpanId.

INVALID - Static variable in class io.opencensus.trace.TraceId

The invalid TraceId.

INVALID_ARGUMENT - Static variable in class io.opencensus.trace.Status

Client specified an invalid argument.

io.opencensus.common - package io.opencensus.common

io.opencensus.stats - package io.opencensus.stats

io.opencensus.tags - package io.opencensus.tags

API for associating tags with scoped operations.

io.opencensus.tags.propagation - package io.opencensus.tags.propagation

io.opencensus.tags.unsafe - package io.opencensus.tags.unsafe

io.opencensus.trace - package io.opencensus.trace

io.opencensus.trace.config - package io.opencensus.trace.config

io.opencensus.trace.export - package io.opencensus.trace.export

io.opencensus.trace.propagation - package io.opencensus.trace.propagation

io.opencensus.trace.samplers - package io.opencensus.trace.samplers

io.opencensus.trace.unsafe - package io.opencensus.trace.unsafe

isOk() - Method in class io.opencensus.trace.Status

Returns true if this Status is OK, i.e., not an error.

isSampled() - Method in class io.opencensus.trace.TraceOptions

Returns a boolean indicating whether this Span is part of a sampled trace and data should be exported to a persistent store.

isValid() - Method in class io.opencensus.trace.SpanContext

Returns true if this SpanContext is valid.

isValid() - Method in class io.opencensus.trace.SpanId

Returns whether the span identifier is valid.

isValid() - Method in class io.opencensus.trace.TraceId

Returns whether the TraceId is valid.

L

Link - Class in io.opencensus.trace

A link to a Span from a different trace.

Link.Type - Enum in io.opencensus.trace

The relationship with the linked Span relative to the current Span.

longAttributeValue(long) - Static method in class io.opencensus.trace.AttributeValue

Returns an AttributeValue with a long value.

M

match(Function<? super Aggregation.Sum, T>, Function<? super Aggregation.Count, T>, Function<? super Aggregation.Mean, T>, Function<? super Aggregation.Distribution, T>, Function<? super Aggregation, T>) - Method in class io.opencensus.stats.Aggregation.Count

match(Function<? super Aggregation.Sum, T>, Function<? super Aggregation.Count, T>, Function<? super Aggregation.Mean, T>, Function<? super Aggregation.Distribution, T>, Function<? super Aggregation, T>) - Method in class io.opencensus.stats.Aggregation.Distribution

match(Function<? super Aggregation.Sum, T>, Function<? super Aggregation.Count, T>, Function<? super Aggregation.Mean, T>, Function<? super Aggregation.Distribution, T>, Function<? super Aggregation, T>) - Method in class io.opencensus.stats.Aggregation

Applies the given match function to the underlying data type.

match(Function<? super Aggregation.Sum, T>, Function<? super Aggregation.Count, T>, Function<? super Aggregation.Mean, T>, Function<? super Aggregation.Distribution, T>, Function<? super Aggregation, T>) - Method in class io.opencensus.stats.Aggregation.Mean

match(Function<? super Aggregation.Sum, T>, Function<? super Aggregation.Count, T>, Function<? super Aggregation.Mean, T>, Function<? super Aggregation.Distribution, T>, Function<? super Aggregation, T>) - Method in class io.opencensus.stats.Aggregation.Sum

match(Function<? super AggregationData.SumDataDouble, T>, Function<? super AggregationData.SumDataLong, T>, Function<? super AggregationData.CountData, T>, Function<? super AggregationData.MeanData, T>, Function<? super AggregationData.DistributionData, T>, Function<? super AggregationData, T>) - Method in class io.opencensus.stats.AggregationData.CountData

match(Function<? super AggregationData.SumDataDouble, T>, Function<? super AggregationData.SumDataLong, T>, Function<? super AggregationData.CountData, T>, Function<? super AggregationData.MeanData, T>, Function<? super AggregationData.DistributionData, T>, Function<? super AggregationData, T>) - Method in class io.opencensus.stats.AggregationData.DistributionData

match(Function<? super AggregationData.SumDataDouble, T>, Function<? super AggregationData.SumDataLong, T>, Function<? super AggregationData.CountData, T>, Function<? super AggregationData.MeanData, T>, Function<? super AggregationData.DistributionData, T>, Function<? super AggregationData, T>) - Method in class io.opencensus.stats.AggregationData

Applies the given match function to the underlying data type.

match(Function<? super AggregationData.SumDataDouble, T>, Function<? super AggregationData.SumDataLong, T>, Function<? super AggregationData.CountData, T>, Function<? super AggregationData.MeanData, T>, Function<? super AggregationData.DistributionData, T>, Function<? super AggregationData, T>) - Method in class io.opencensus.stats.AggregationData.MeanData

match(Function<? super AggregationData.SumDataDouble, T>, Function<? super AggregationData.SumDataLong, T>, Function<? super AggregationData.CountData, T>, Function<? super AggregationData.MeanData, T>, Function<? super AggregationData.DistributionData, T>, Function<? super AggregationData, T>) - Method in class io.opencensus.stats.AggregationData.SumDataDouble

match(Function<? super AggregationData.SumDataDouble, T>, Function<? super AggregationData.SumDataLong, T>, Function<? super AggregationData.CountData, T>, Function<? super AggregationData.MeanData, T>, Function<? super AggregationData.DistributionData, T>, Function<? super AggregationData, T>) - Method in class io.opencensus.stats.AggregationData.SumDataLong

match(Function<? super Measure.MeasureDouble, T>, Function<? super Measure.MeasureLong, T>, Function<? super Measure, T>) - Method in class io.opencensus.stats.Measure

Applies the given match function to the underlying data type.

match(Function<? super Measure.MeasureDouble, T>, Function<? super Measure.MeasureLong, T>, Function<? super Measure, T>) - Method in class io.opencensus.stats.Measure.MeasureDouble

match(Function<? super Measure.MeasureDouble, T>, Function<? super Measure.MeasureLong, T>, Function<? super Measure, T>) - Method in class io.opencensus.stats.Measure.MeasureLong

match(Function<? super Measurement.MeasurementDouble, T>, Function<? super Measurement.MeasurementLong, T>, Function<? super Measurement, T>) - Method in class io.opencensus.stats.Measurement

Applies the given match function to the underlying data type.

match(Function<? super Measurement.MeasurementDouble, T>, Function<? super Measurement.MeasurementLong, T>, Function<? super Measurement, T>) - Method in class io.opencensus.stats.Measurement.MeasurementDouble

match(Function<? super Measurement.MeasurementDouble, T>, Function<? super Measurement.MeasurementLong, T>, Function<? super Measurement, T>) - Method in class io.opencensus.stats.Measurement.MeasurementLong

match(Function<? super View.AggregationWindow.Cumulative, T>, Function<? super View.AggregationWindow.Interval, T>, Function<? super View.AggregationWindow, T>) - Method in class io.opencensus.stats.View.AggregationWindow.Cumulative

match(Function<? super View.AggregationWindow.Cumulative, T>, Function<? super View.AggregationWindow.Interval, T>, Function<? super View.AggregationWindow, T>) - Method in class io.opencensus.stats.View.AggregationWindow.Interval

match(Function<? super View.AggregationWindow.Cumulative, T>, Function<? super View.AggregationWindow.Interval, T>, Function<? super View.AggregationWindow, T>) - Method in class io.opencensus.stats.View.AggregationWindow

Applies the given match function to the underlying data type.

match(Function<? super ViewData.AggregationWindowData.CumulativeData, T>, Function<? super ViewData.AggregationWindowData.IntervalData, T>, Function<? super ViewData.AggregationWindowData, T>) - Method in class io.opencensus.stats.ViewData.AggregationWindowData.CumulativeData

match(Function<? super ViewData.AggregationWindowData.CumulativeData, T>, Function<? super ViewData.AggregationWindowData.IntervalData, T>, Function<? super ViewData.AggregationWindowData, T>) - Method in class io.opencensus.stats.ViewData.AggregationWindowData.IntervalData

match(Function<? super ViewData.AggregationWindowData.CumulativeData, T>, Function<? super ViewData.AggregationWindowData.IntervalData, T>, Function<? super ViewData.AggregationWindowData, T>) - Method in class io.opencensus.stats.ViewData.AggregationWindowData

Applies the given match function to the underlying data type.

match(Function<? super String, T>, Function<? super Boolean, T>, Function<? super Long, T>, Function<Object, T>) - Method in class io.opencensus.trace.AttributeValue

Applies a function to the underlying value.

MAX_LENGTH - Static variable in class io.opencensus.tags.TagKey

The maximum length for a tag key name.

MAX_LENGTH - Static variable in class io.opencensus.tags.TagValue

The maximum length for a tag value.

Measure - Class in io.opencensus.stats

The definition of the Measurement that is taken by OpenCensus library.

Measure.MeasureDouble - Class in io.opencensus.stats

Measure with Double typed values.

Measure.MeasureLong - Class in io.opencensus.stats

Measure with Long typed values.

MeasureMap - Class in io.opencensus.stats

A map from Measures to measured values to be recorded at the same time.

MeasureMap() - Constructor for class io.opencensus.stats.MeasureMap

Measurement - Class in io.opencensus.stats

Immutable representation of a Measurement.

Measurement.MeasurementDouble - Class in io.opencensus.stats

Double typed Measurement.

Measurement.MeasurementLong - Class in io.opencensus.stats

Long typed Measurement.

N

NetworkEvent - Class in io.opencensus.trace

A class that represents a network event.

NetworkEvent.Builder - Class in io.opencensus.trace

Builder class for NetworkEvent.

NetworkEvent.Type - Enum in io.opencensus.trace

Available types for a NetworkEvent.

neverSample() - Static method in class io.opencensus.trace.samplers.Samplers

Returns a Sampler that always makes a "no" decision on Span sampling.

newMeasureMap() - Method in class io.opencensus.stats.StatsRecorder

Returns an object for recording multiple measurements.

newNoopExportComponent() - Static method in class io.opencensus.trace.export.ExportComponent

Returns the no-op implementation of the ExportComponent.

NonThrowingCloseable - Interface in io.opencensus.common

Deprecated.

Scope is a better match for operations involving the current context.

NOT_FOUND - Static variable in class io.opencensus.trace.Status

Some requested entity (e.g., file or directory) was not found.

now() - Method in class io.opencensus.common.Clock

Obtains the current instant from this clock.

nowNanos() - Method in class io.opencensus.common.Clock

Returns a time measurement with nanosecond precision that can only be used to calculate elapsed time.

O

OK - Static variable in class io.opencensus.trace.Status

The operation completed successfully.

OpenCensusLibraryInformation - Class in io.opencensus.common

Class holder for all common constants (such as the version) for the OpenCensus Java library.

OUT_OF_RANGE - Static variable in class io.opencensus.trace.Status

Operation was attempted past the valid range.

P

PERMISSION_DENIED - Static variable in class io.opencensus.trace.Status

The caller does not have permission to execute the specified operation.

probabilitySampler(double) - Static method in class io.opencensus.trace.samplers.Samplers

Returns a Sampler that makes a "yes" decision with a given probability.

PropagationComponent - Class in io.opencensus.trace.propagation

Container class for all the supported propagation formats.

PropagationComponent() - Constructor for class io.opencensus.trace.propagation.PropagationComponent

put(Measure.MeasureDouble, double) - Method in class io.opencensus.stats.MeasureMap

Associates the Measure.MeasureDouble with the given value.

put(Measure.MeasureLong, long) - Method in class io.opencensus.stats.MeasureMap

Associates the Measure.MeasureLong with the given value.

put(TagKey, TagValue) - Method in class io.opencensus.tags.TagContextBuilder

Adds the key/value pair regardless of whether the key is present.

putAttribute(String, AttributeValue) - Method in class io.opencensus.trace.BlankSpan

No-op implementation of the Span.putAttribute(String, AttributeValue) method.

putAttribute(String, AttributeValue) - Method in class io.opencensus.trace.Span

Sets an attribute to the Span.

putAttributes(Map<String, AttributeValue>) - Method in class io.opencensus.trace.BlankSpan

No-op implementation of the Span.putAttributes(Map) method.

putAttributes(Map<String, AttributeValue>) - Method in class io.opencensus.trace.Span

Sets a set of attributes to the Span.

R

record() - Method in class io.opencensus.stats.MeasureMap

Records all of the measures at the same time, with the current TagContext.

record(TagContext) - Method in class io.opencensus.stats.MeasureMap

Records all of the measures at the same time, with an explicit TagContext.

registerHandler(String, SpanExporter.Handler) - Method in class io.opencensus.trace.export.SpanExporter

Registers a new service handler that is used by the library to export SpanData for sampled spans (see TraceOptions.isSampled()).

registerSpanNamesForCollection(Collection<String>) - Method in class io.opencensus.trace.export.SampledSpanStore

Appends a list of span names for which the library will collect latency based sampled spans and error based sampled spans.

registerView(View) - Method in class io.opencensus.stats.ViewManager

Pull model for stats.

remove(TagKey) - Method in class io.opencensus.tags.TagContextBuilder

Removes the key if it exists.

RESOURCE_EXHAUSTED - Static variable in class io.opencensus.trace.Status

Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.

returnConstant(T) - Static method in class io.opencensus.common.Functions

A Function that always ignores its argument and returns a constant value.

returnNull() - Static method in class io.opencensus.common.Functions

A Function that always ignores its argument and returns null.

RunningSpanStore - Class in io.opencensus.trace.export

This class allows users to access in-process information about all running spans.

RunningSpanStore() - Constructor for class io.opencensus.trace.export.RunningSpanStore

RunningSpanStore.Filter - Class in io.opencensus.trace.export

Filter for running spans.

RunningSpanStore.PerSpanNameSummary - Class in io.opencensus.trace.export

Summary of all available data for a span name.

RunningSpanStore.Summary - Class in io.opencensus.trace.export

The summary of all available data.

S

SampledSpanStore - Class in io.opencensus.trace.export

This class allows users to access in-process information such as latency based sampled spans and error based sampled spans.

SampledSpanStore() - Constructor for class io.opencensus.trace.export.SampledSpanStore

SampledSpanStore.ErrorFilter - Class in io.opencensus.trace.export

Filter for error based sampled spans.

SampledSpanStore.LatencyBucketBoundaries - Enum in io.opencensus.trace.export

The latency buckets boundaries.

SampledSpanStore.LatencyFilter - Class in io.opencensus.trace.export

Filter for latency based sampled spans.

SampledSpanStore.PerSpanNameSummary - Class in io.opencensus.trace.export

Summary of all available data for a span name.

SampledSpanStore.Summary - Class in io.opencensus.trace.export

The summary of all available data.

Sampler - Class in io.opencensus.trace

Sampler is used to make decisions on Span sampling.

Sampler() - Constructor for class io.opencensus.trace.Sampler

Samplers - Class in io.opencensus.trace.samplers

Static class to access a set of pre-defined Samplers.

Scope - Interface in io.opencensus.common

A Closeable that represents a change to the current context over a scope of code.

setCompressedMessageSize(long) - Method in class io.opencensus.trace.NetworkEvent.Builder

Sets the compressed message size.

setIsSampled() - Method in class io.opencensus.trace.TraceOptions.Builder

Deprecated.

Use Builder.setIsSampled(true).

setIsSampled(boolean) - Method in class io.opencensus.trace.TraceOptions.Builder

Sets the sampling bit in the options.

setKernelTimestamp(Timestamp) - Method in class io.opencensus.trace.NetworkEvent.Builder

Sets the kernel timestamp.

setMaxNumberOfAnnotations(int) - Method in class io.opencensus.trace.config.TraceParams.Builder

Sets the global default max number of Annotation events per Span.

setMaxNumberOfAttributes(int) - Method in class io.opencensus.trace.config.TraceParams.Builder

Sets the global default max number of attributes per Span.

setMaxNumberOfLinks(int) - Method in class io.opencensus.trace.config.TraceParams.Builder

Sets the global default max number of Link entries per Span.

setMaxNumberOfNetworkEvents(int) - Method in class io.opencensus.trace.config.TraceParams.Builder

Sets the global default max number of NetworkEvent events per Span.

setMessageSize(long) - Method in class io.opencensus.trace.NetworkEvent.Builder

Deprecated.

Use NetworkEvent.Builder.setUncompressedMessageSize(long).

setParentLinks(List<Span>) - Method in class io.opencensus.trace.SpanBuilder

Sets the List of parent links.

setRecordEvents(boolean) - Method in class io.opencensus.trace.SpanBuilder

Sets the option Span.Options.RECORD_EVENTS for the newly created Span.

setSampler(Sampler) - Method in class io.opencensus.trace.config.TraceParams.Builder

Sets the global default Sampler.

setSampler(Sampler) - Method in class io.opencensus.trace.SpanBuilder

Sets the Sampler to use.

setSampleToLocalSpanStore(boolean) - Method in class io.opencensus.trace.EndSpanOptions.Builder

If set to true this is equivalent with calling the SampledSpanStore.registerSpanNamesForCollection(Collection) in advance for the given span name.

setState(StatsCollectionState) - Static method in class io.opencensus.stats.Stats

Deprecated.

This method is deprecated because other libraries could cache the result of Stats.getState(), use a stale value, and behave incorrectly. It is only safe to call early in initialization. This method throws IllegalStateException after getState() has been called, in order to limit changes to the result of getState().

setState(StatsCollectionState) - Method in class io.opencensus.stats.StatsComponent

Deprecated.

This method is deprecated because other libraries could cache the result of StatsComponent.getState(), use a stale value, and behave incorrectly. It is only safe to call early in initialization. This method throws IllegalStateException after getState() has been called, in order to limit changes to the result of getState().

setState(TaggingState) - Static method in class io.opencensus.tags.Tags

Deprecated.

This method is deprecated because other libraries could cache the result of Tags.getState(), use a stale value, and behave incorrectly. It is only safe to call early in initialization. This method throws IllegalStateException after Tags.getState() has been called, in order to limit changes to the result of getState().

setState(TaggingState) - Method in class io.opencensus.tags.TagsComponent

Deprecated.

This method is deprecated because other libraries could cache the result of TagsComponent.getState(), use a stale value, and behave incorrectly. It is only safe to call early in initialization. This method throws IllegalStateException after getState() has been called, in order to limit changes to the result of getState().

setStatus(Status) - Method in class io.opencensus.trace.BlankSpan

setStatus(Status) - Method in class io.opencensus.trace.EndSpanOptions.Builder

Sets the status for the Span.

setStatus(Status) - Method in class io.opencensus.trace.Span

Sets the Status to the Span.

setUncompressedMessageSize(long) - Method in class io.opencensus.trace.NetworkEvent.Builder

Sets the uncompressed message size.

shouldSample(SpanContext, Boolean, TraceId, SpanId, String, List<Span>) - Method in class io.opencensus.trace.Sampler

Called during Span creation to make a sampling decision.

SIZE - Static variable in class io.opencensus.trace.SpanId

The size in bytes of the SpanId.

SIZE - Static variable in class io.opencensus.trace.TraceId

The size in bytes of the TraceId.

SIZE - Static variable in class io.opencensus.trace.TraceOptions

The size in bytes of the TraceOptions.

Span - Class in io.opencensus.trace

An abstract class that represents a span.

Span(SpanContext, EnumSet<Span.Options>) - Constructor for class io.opencensus.trace.Span

Creates a new Span.

Span.Options - Enum in io.opencensus.trace

Span options.

SpanBuilder - Class in io.opencensus.trace

SpanBuilder is used to construct Span instances which define arbitrary scopes of code that are sampled for distributed tracing as a single atomic unit.

SpanBuilder() - Constructor for class io.opencensus.trace.SpanBuilder

spanBuilder(String) - Method in class io.opencensus.trace.Tracer

Returns a SpanBuilder to create and start a new child Span as a child of to the current Span if any, otherwise creates a root Span.

spanBuilderWithExplicitParent(String, Span) - Method in class io.opencensus.trace.Tracer

Returns a SpanBuilder to create and start a new child Span (or root if parent is null or has an invalid SpanContext), with parent being the designated Span.

spanBuilderWithRemoteParent(String, SpanContext) - Method in class io.opencensus.trace.Tracer

Returns a SpanBuilder to create and start a new child Span (or root if parent is SpanContext.INVALID or null), with parent being the remote Span designated by the SpanContext.

SpanContext - Class in io.opencensus.trace

A class that represents a span context.

SpanContextParseException - Exception in io.opencensus.trace.propagation

Exception thrown when a SpanContext cannot be parsed.

SpanContextParseException(String) - Constructor for exception io.opencensus.trace.propagation.SpanContextParseException

Constructs a new SpanContextParseException with the given message.

SpanContextParseException(String, Throwable) - Constructor for exception io.opencensus.trace.propagation.SpanContextParseException

Constructs a new SpanContextParseException with the given message and cause.

SpanData - Class in io.opencensus.trace.export

Immutable representation of all data collected by the Span class.

SpanData.Attributes - Class in io.opencensus.trace.export

A set of attributes and the number of dropped attributes representation.

SpanData.Links - Class in io.opencensus.trace.export

A list of links and the number of dropped links representation.

SpanData.TimedEvent<T> - Class in io.opencensus.trace.export

A timed event representation.

SpanData.TimedEvents<T> - Class in io.opencensus.trace.export

A list of timed events and the number of dropped events representation.

SpanExporter - Class in io.opencensus.trace.export

A service that is used by the library to export SpanData for all the spans that are part of a distributed sampled trace (see TraceOptions.isSampled()).

SpanExporter() - Constructor for class io.opencensus.trace.export.SpanExporter

SpanExporter.Handler - Class in io.opencensus.trace.export

An abstract class that allows different tracing services to export recorded data for sampled spans in their own format.

SpanId - Class in io.opencensus.trace

A class that represents a span identifier.

startScopedSpan() - Method in class io.opencensus.trace.SpanBuilder

Starts a new span and sets it as the current span.

startSpan() - Method in class io.opencensus.trace.SpanBuilder

Starts a new Span.

Stats - Class in io.opencensus.stats

Class for accessing the default StatsComponent.

StatsCollectionState - Enum in io.opencensus.stats

State of the StatsComponent.

StatsComponent - Class in io.opencensus.stats

Class that holds the implementations for ViewManager and StatsRecorder.

StatsComponent() - Constructor for class io.opencensus.stats.StatsComponent

StatsRecorder - Class in io.opencensus.stats

Provides methods to record stats against tags.

StatsRecorder() - Constructor for class io.opencensus.stats.StatsRecorder

Status - Class in io.opencensus.trace

Defines the status of a Span by providing a standard Status.CanonicalCode in conjunction with an optional descriptive message.

Status.CanonicalCode - Enum in io.opencensus.trace

The set of canonical status codes.

stringAttributeValue(String) - Static method in class io.opencensus.trace.AttributeValue

Returns an AttributeValue with a string value.

subtractTimestamp(Timestamp) - Method in class io.opencensus.common.Timestamp

Returns a Duration calculated as: this - timestamp.

T

Tag - Class in io.opencensus.tags

TagKey paired with a TagValue.

TAG_CONTEXT_KEY - Static variable in class io.opencensus.tags.unsafe.ContextUtils

The Context.Key used to interact with the TagContext contained in the Context.

TagContext - Class in io.opencensus.tags

A map from TagKey to TagValue that can be used to label anything that is associated with a specific operation.

TagContext() - Constructor for class io.opencensus.tags.TagContext

TagContextBinarySerializer - Class in io.opencensus.tags.propagation

Object for serializing and deserializing TagContexts with the binary format.

TagContextBinarySerializer() - Constructor for class io.opencensus.tags.propagation.TagContextBinarySerializer

TagContextBuilder - Class in io.opencensus.tags

Builder for the TagContext class.

TagContextBuilder() - Constructor for class io.opencensus.tags.TagContextBuilder

TagContextDeserializationException - Exception in io.opencensus.tags.propagation

Exception thrown when a TagContext cannot be parsed.

TagContextDeserializationException(String) - Constructor for exception io.opencensus.tags.propagation.TagContextDeserializationException

Constructs a new TagContextParseException with the given message.

TagContextDeserializationException(String, Throwable) - Constructor for exception io.opencensus.tags.propagation.TagContextDeserializationException

Constructs a new TagContextParseException with the given message and cause.

TagContextSerializationException - Exception in io.opencensus.tags.propagation

Exception thrown when a TagContext cannot be serialized.

TagContextSerializationException(String) - Constructor for exception io.opencensus.tags.propagation.TagContextSerializationException

Constructs a new TagContextSerializationException with the given message.

TagContextSerializationException(String, Throwable) - Constructor for exception io.opencensus.tags.propagation.TagContextSerializationException

Constructs a new TagContextSerializationException with the given message and cause.

Tagger - Class in io.opencensus.tags

Object for creating new TagContexts and TagContexts based on the current context.

Tagger() - Constructor for class io.opencensus.tags.Tagger

TaggingState - Enum in io.opencensus.tags

State of the TagsComponent.

TagKey - Class in io.opencensus.tags

A key to a value stored in a TagContext.

TagPropagationComponent - Class in io.opencensus.tags.propagation

Object containing all supported TagContext propagation formats.

TagPropagationComponent() - Constructor for class io.opencensus.tags.propagation.TagPropagationComponent

Tags - Class in io.opencensus.tags

Class for accessing the default TagsComponent.

TagsComponent - Class in io.opencensus.tags

Class that holds the implementation for Tagger and TagPropagationComponent.

TagsComponent() - Constructor for class io.opencensus.tags.TagsComponent

TagValue - Class in io.opencensus.tags

A validated tag value.

throwAssertionError() - Static method in class io.opencensus.common.Functions

A Function that always ignores its argument and throws an AssertionError.

throwIllegalArgumentException() - Static method in class io.opencensus.common.Functions

A Function that always ignores its argument and throws an IllegalArgumentException.

Timestamp - Class in io.opencensus.common

A representation of an instant in time.

toBinaryValue(SpanContext) - Method in class io.opencensus.trace.propagation.BinaryFormat

Deprecated.

use BinaryFormat.toByteArray(SpanContext).

toBuilder(TagContext) - Method in class io.opencensus.tags.Tagger

Returns a builder based on this TagContext.

toBuilder() - Method in class io.opencensus.trace.config.TraceParams

Returns a TraceParams.Builder initialized to the same property values as the current instance.

toByteArray(TagContext) - Method in class io.opencensus.tags.propagation.TagContextBinarySerializer

Serializes the TagContext into the on-the-wire representation.

toByteArray(SpanContext) - Method in class io.opencensus.trace.propagation.BinaryFormat

Serializes a SpanContext into a byte array using the binary format.

toStatus() - Method in enum io.opencensus.trace.Status.CanonicalCode

Returns the status that has the current CanonicalCode..

toString() - Method in class io.opencensus.tags.TagContext

toString() - Method in class io.opencensus.trace.BlankSpan

toString() - Method in class io.opencensus.trace.SpanContext

toString() - Method in class io.opencensus.trace.SpanId

toString() - Method in class io.opencensus.trace.Status

toString() - Method in class io.opencensus.trace.TraceId

toString() - Method in class io.opencensus.trace.TraceOptions

TraceComponent - Class in io.opencensus.trace

Class that holds the implementation instances for Tracer, PropagationComponent, Clock, ExportComponent and TraceConfig.

TraceComponent() - Constructor for class io.opencensus.trace.TraceComponent

TraceConfig - Class in io.opencensus.trace.config

Global configuration of the trace service.

TraceConfig() - Constructor for class io.opencensus.trace.config.TraceConfig

TraceId - Class in io.opencensus.trace

A class that represents a trace identifier.

TraceOptions - Class in io.opencensus.trace

A class that represents global trace options.

TraceOptions.Builder - Class in io.opencensus.trace

Builder class for TraceOptions.

TraceParams - Class in io.opencensus.trace.config

Class that holds global trace parameters.

TraceParams() - Constructor for class io.opencensus.trace.config.TraceParams

TraceParams.Builder - Class in io.opencensus.trace.config

A Builder class for TraceParams.

Tracer - Class in io.opencensus.trace

Tracer is a simple, thin class for Span creation and in-process context interaction.

Tracer() - Constructor for class io.opencensus.trace.Tracer

Tracing - Class in io.opencensus.trace

Class that manages a global instance of the TraceComponent.

U

UNAUTHENTICATED - Static variable in class io.opencensus.trace.Status

The request does not have valid authentication credentials for the operation.

UNAVAILABLE - Static variable in class io.opencensus.trace.Status

The service is currently unavailable.

UNIMPLEMENTED - Static variable in class io.opencensus.trace.Status

Operation is not implemented or not supported/enabled in this service.

UNKNOWN - Static variable in class io.opencensus.trace.Status

Unknown error.

unregisterHandler(String) - Method in class io.opencensus.trace.export.SpanExporter

Unregisters the service handler with the provided name.

unregisterSpanNamesForCollection(Collection<String>) - Method in class io.opencensus.trace.export.SampledSpanStore

Removes a list of span names for which the library will collect latency based sampled spans and error based sampled spans.

updateActiveTraceParams(TraceParams) - Method in class io.opencensus.trace.config.TraceConfig

Updates the active TraceParams.

V

value() - Method in enum io.opencensus.trace.Status.CanonicalCode

Returns the numerical value of the code.

valueOf(String) - Static method in enum io.opencensus.stats.StatsCollectionState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.opencensus.tags.TaggingState

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.opencensus.trace.export.SampledSpanStore.LatencyBucketBoundaries

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.opencensus.trace.Link.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.opencensus.trace.NetworkEvent.Type

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.opencensus.trace.Span.Options

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum io.opencensus.trace.Status.CanonicalCode

Returns the enum constant of this type with the specified name.

values() - Static method in enum io.opencensus.stats.StatsCollectionState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.opencensus.tags.TaggingState

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.opencensus.trace.export.SampledSpanStore.LatencyBucketBoundaries

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.opencensus.trace.Link.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.opencensus.trace.NetworkEvent.Type

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.opencensus.trace.Span.Options

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum io.opencensus.trace.Status.CanonicalCode

Returns an array containing the constants of this enum type, in the order they are declared.

VERSION - Static variable in class io.opencensus.common.OpenCensusLibraryInformation

The current version of the OpenCensus Java library.

View - Class in io.opencensus.stats

A View specifies an aggregation and a set of tag keys.

View.AggregationWindow - Class in io.opencensus.stats

The time window for a View.

View.AggregationWindow.Cumulative - Class in io.opencensus.stats

Cumulative (infinite interval) time AggregationWindow.

View.AggregationWindow.Interval - Class in io.opencensus.stats

Interval (finite interval) time AggregationWindow.

View.Name - Class in io.opencensus.stats

The name of a View.

ViewData - Class in io.opencensus.stats

The aggregated data for a particular View.

ViewData.AggregationWindowData - Class in io.opencensus.stats

The AggregationWindowData for a ViewData.

ViewData.AggregationWindowData.CumulativeData - Class in io.opencensus.stats

Cumulative AggregationWindowData.

ViewData.AggregationWindowData.IntervalData - Class in io.opencensus.stats

Interval AggregationWindowData.

ViewManager - Class in io.opencensus.stats

Provides facilities to register Views for collecting stats and retrieving stats data as a ViewData.

ViewManager() - Constructor for class io.opencensus.stats.ViewManager

W

withDescription(String) - Method in class io.opencensus.trace.Status

Creates a derived instance of Status with the given description.

withSpan(Span) - Method in class io.opencensus.trace.Tracer

Enters the scope of code where the given Span is in the current Context, and returns an object that represents that scope.

withTagContext(TagContext) - Method in class io.opencensus.tags.Tagger

Enters the scope of code where the given TagContext is in the current context and returns an object that represents that scope.

A B C D E F G H I L M N O P R S T U V W