All Classes and Interfaces
Class
Description
Base class for handling request on http client and server.
Aggregation
is the process of combining a certain set of MeasureValue
s for a
given Measure
into an AggregationData
.Calculate count on aggregated
MeasureValue
s.Calculate distribution stats on aggregated
MeasureValue
s.Calculate the last value of aggregated
MeasureValue
s.Deprecated.
Calculate sum on aggregated
MeasureValue
s.The count value of aggregated
MeasureValue
s.The distribution stats of aggregated
MeasureValue
s.The last value of aggregated
MeasureValueDouble
s.The last value of aggregated
MeasureValueLong
s.Deprecated.
since 0.13, use
AggregationData.DistributionData
instead.The sum value of aggregated
MeasureValueDouble
s.The sum value of aggregated
MeasureValueLong
s.Sampler that always makes a "yes" decision on
Span
sampling.A text annotation with a set of attributes.
The value of
Exemplar
attachment.String
AttachmentValue
.A class that represents all the possible values for an attribute.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Deprecated.
Util methods for getting and parsing AWS instance identity document.
Implementation of the B3 propagation protocol.
Deprecated.
This class is for internal use only.
Helper class to convert/cast between for
MessageEvent
and NetworkEvent
.This is a helper class for
SpanContext
propagation on the wire using binary encoding.Implementation of the
BinaryFormat
.Methods for serializing and deserializing
TagContext
s.The
BlankSpan
is a singleton class, which is the default Span
that is used when
no Span
implementation is available.The bucket boundaries for a histogram.
Utility methods for suppressing nullness warnings and working around Checker Framework issues.
Interface for getting the current time.
Helper class for Cloud
Resource
environment.Implementation of the "X-Cloud-Trace-Context" format, defined by the Google Cloud Trace.
An
ConcurrentIntrusiveList<T>
is a doubly-linked list where the link pointers are
embedded in the elements.This is an interface that must be implemented by any element that uses
ConcurrentIntrusiveList
.Helper class for K8S container
Resource
.ContextHandle
implementation using .Default
ContextManager
implementation using io.grpc.ContextUtility methods for accessing the
TagContext
contained in the Context
.Deprecated.
Please use
ContextHandleUtils
Util
methods/functionality to interact with the Context
.Implementation of the W3C correlation context propagation protocol.
Util methods/functionality to interact with the
Span
in the Context
.The current state base implementation for stats and tags.
Current state for stats or tags.
Utility methods for accessing the
TagContext
contained in the Context
.A
ThreadFactory
implementation that starts all Thread
as daemons.Indicates that an element is package-private instead of private only for the purpose of testing.
Derived Double Cumulative metric, to report cumulative measurement of a double value.
No-op implementations of DerivedDoubleCumulative class.
Implementation of
DerivedDoubleCumulative
.Implementation of
DerivedDoubleCumulativeImpl.PointWithFunction
with an object and a callback function.Derived Double Gauge metric, to report instantaneous measurement of a double value.
No-op implementations of DerivedDoubleGauge class.
Implementation of
DerivedDoubleGauge
.Implementation of
DerivedDoubleGaugeImpl.PointWithFunction
with an object and a callback function.Derived Long Cumulative metric, to report cumulative measurement of an int64 value.
No-op implementations of DerivedLongCumulative class.
Implementation of
DerivedLongCumulative
.Implementation of
DerivedLongCumulativeImpl.PointWithFunction
with an object and a callback function.Derived Long Gauge metric, to report instantaneous measurement of an int64 value.
No-op implementations of DerivedLongGauge class.
Implementation of
DerivedLongGauge
.Implementation of
DerivedLongGaugeImpl.PointWithFunction
with an object and a callback function.A low-latency event queue for background updating of (possibly contended) objects.
Every event that gets added to
EventQueue
will get processed here.Distribution
contains summary statistics for a population of values.The histogram bucket of the population values.
The bucket options used to create a histogram for the distribution.
A Bucket with explicit bounds
Distribution.BucketOptions
.Double Cumulative metric, to report instantaneous measurement of a double value.
The value of a single point in the Cumulative.TimeSeries.
No-op implementations of DoubleCumulative class.
No-op implementations of DoublePoint class.
Implementation of
DoubleCumulative
.Implementation of
DoubleCumulative.DoublePoint
.Double Gauge metric, to report instantaneous measurement of a double value.
The value of a single point in the Gauge.TimeSeries.
No-op implementations of DoubleGauge class.
No-op implementations of DoublePoint class.
Implementation of
DoubleGauge
.Implementation of
DoubleGauge.DoublePoint
.Represents a signed, fixed-length span of time represented as a count of seconds and fractions of
seconds at nanosecond resolution.
A class that enables overriding the default values used when ending a
Span
.Builder class for
EndSpanOptions
.A queue that processes events.
Base interface to be used for all entries in
EventQueue
.An example point that may be used to annotate aggregated distribution values, associated with a
histogram bucket.
Utils for recording
Exemplar
s for OpenCensus stats.Indicates a public API that can change at any time, and has no guarantee of API stability and
backward-compatibility.
Class that holds the implementation instance for
MetricProducerManager
.Class that holds the implementation instances for
SpanExporter
, RunningSpanStore
and SampledSpanStore
.Implementation of
ExportComponent
.Implementation of the
ExportComponent
.Contains both
ContainerRequestContext
and ResourceInfo
.Used to specify matching functions for use encoding tagged unions (i.e.
Commonly used
Function
instances.Retrieves Google Cloud project-id and a limited set of instance attributes from Metadata server.
Helper class for Host
Resource
.This helper class provides routine methods to instrument HTTP clients.
An adaptor to extract information from request and response.
Utility class to get all supported
TextFormat
.This class provides storage per request context on http client and server.
This class extracts attributes from Http Client Request and Response.
This helper class provides routine methods to instrument HTTP servers.
Constant Trace attribute keys for HTTP Request and Response @Since 0.18
A helper class to provide convenience methods for tracing.
A helper class that holds OpenCensus's default HTTP
View
s.A helper class that allows users to register HTTP views easily.
In-process implementation of the
RunningSpanStore
.In-process implementation of the
SampledSpanStore
.Keeps samples for a given span name.
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 tagging utilities.
The bucket with aggregated
MeasureValue
s used for IntervalViewData
.Wrapper of the
MetricReader
which automatically reads and exports the metrics every
export interval.Options for
IntervalMetricReader
.Builder for
IntervalMetricReader.Options
.Extracts information from JAX-RS client request and response.
JAX-RS client request and response filter to provide instrumentation of client calls with
OpenCensus.
Extracts information from JAX-RS container request and response.
JAX-RS request and response filter to provide instrumentation of JAX-RS based endpoint with
OpenCensus.
Helper class for Kubernetes deployment service
Resource
.The key of a
Label
associated with a MetricDescriptor
.The value of a
Label
associated with a TimeSeries
.A link to a
Span
from a different trace.The relationship with the linked
Span
relative to the current Span
.Long Cumulative metric, to report instantaneous measurement of an int64 value.
The value of a single point in the Cumulative.TimeSeries.
No-op implementations of LongCumulative class.
No-op implementations of LongPoint class.
Implementation of
LongCumulative
.Implementation of
LongCumulative.LongPoint
.Long Gauge metric, to report instantaneous measurement of an int64 value.
The value of a single point in the Gauge.TimeSeries.
No-op implementations of LongGauge class.
No-op implementations of LongPoint class.
Implementation of
LongGauge
.Implementation of
LongGauge.LongPoint
.The definition of the
Measurement
that is taken by OpenCensus library.Measure
with Double
typed values.Measure
with Long
typed values.A map from
Measure
s to measured values to be recorded at the same time.Implementation of
MeasureMap
.A map from
Measure
's to measured values.Builder for the
MeasureMapInternal
class.Immutable representation of a Measurement.
Double
typed Measurement
.Long
typed Measurement
.A class that stores a singleton map from
MeasureName
s to MutableViewData
s.A class that represents a generic messaging event.
Builder class for
MessageEvent
.Available types for a
MessageEvent
.A
Metric
with one or more TimeSeries
.MetricDescriptor
defines a Metric
type and its schema.The kind of metric.
Abstract class that represents a metric exporter.
Options for every metric added to the
MetricRegistry
.Builder for
MetricOptions
.A
Metric
producer that can be registered for exporting using MetricProducerManager
.Implementation of
MetricProducer
.Keeps a set of
MetricProducer
that is used by exporters to determine the metrics that
need to be exported.Implementation of
MetricProducerManager
.Helper class to read all available
Metric
s from a MetricProducerManager
and
exports them to a MetricExporter
.Options for
MetricReader
.Builder for
MetricReader.Options
.Creates and manages your application's set of metrics.
Implementation of
MetricRegistry
.Annotation to mark JAX-RS endpoint or method for metrics collection.
Class for accessing the default
MetricsComponent
.Class that holds the implementation instance for
ExportComponent
.Implementation of
MetricsComponent
.Implementation of
MetricsComponent
.Android-compatible implementation of
MetricsComponent
.Mutable version of
Aggregation
that supports adding values.Calculate count on aggregated
MeasureValue
s.Calculate distribution stats on aggregated
MeasureValue
s.Calculate double last value on aggregated
MeasureValue
s.Calculate last long value on aggregated
MeasureValue
s.Calculate mean on aggregated
MeasureValue
s.Calculate sum of doubles on aggregated
MeasureValue
s.Calculate sum of longs on aggregated
MeasureValue
s.A mutable version of
ViewData
, used for recording stats and start/end time.Deprecated.
Use
MessageEvent
.Deprecated.
NetworkEvent
is deprecated.Available types for a
NetworkEvent
.Sampler that always makes a "no" decision on
Span
sampling.Deprecated.
Scope
is a better match for operations involving the current context.A
Scope
that does nothing when it is created or closed.A
Scope
that does nothing when it is created or closed.No-op implementations of stats classes.
TagContextBuilder
that is used when tagging is disabled.No-op implementations of tagging classes.
Implementation for the
Span
class that does not record trace events.This class extracts attributes from
HttpServletRequest
and HttpServletResponse
.This filter class implements Filter interface called by web container.
This class implements
AsyncListener
to handle span completion for async request handling.This class is a wrapper to
HttpClient
.This class extracts attributes from
Request
and Response
.Class holder for all common constants (such as the version) for the OpenCensus Java library.
A Log4j
ContextDataInjector
that adds OpenCensus tracing data to log events.A timestamped measurement of a
TimeSeries
.We assume the lower 64 bits of the traceId's are randomly distributed around the whole (long)
range.
Util methods to convert OpenCensus Metrics data models to Prometheus data models.
OpenCensus Metrics
Collector
for Prometheus.Configurations for
PrometheusStatsCollector
.Builder for
PrometheusStatsConfiguration
.Container class for all the supported propagation formats.
Implementation of the
PropagationComponent
.OpenCensus service provider mechanism.
Wrapper of
MetricProducer
which allows metrics to be pushed and buffered.Options for
QueueMetricProducer
.Builder for
QueueMetricProducer.Options
.Abstract class to access the current
Random
.Implementation of the
RandomHandler
using SecureRandom
.Implementation for the
Span
class that records trace events.Interface to handle the start and end operations for a
Span
only when the Span
has Span.Options.RECORD_EVENTS
option.Resource
represents a resource, which capture identifying information about the entities
for which signals (stats or traces) are reported.Utilities for auto detecting resource based on the environment where the application is running.
Constants for collecting rpc stats.
Constants for exporting views on rpc stats.
Helper class that allows users to register rpc views easily.
HTML page formatter for gRPC cumulative and interval stats.
This class allows users to access in-process information about all running spans.
Filter for running spans.
Summary of all available data for a span name.
The summary of all available data.
This class allows users to access in-process information such as latency based sampled spans and
error based sampled spans.
Filter for error based sampled spans.
The latency buckets boundaries.
Filter for latency based sampled spans.
Summary of all available data for a span name.
The summary of all available data.
Abstract implementation of the
SampledSpanStore
.Sampler is used to make decisions on
Span
sampling.Static class to access a set of pre-defined
Samplers
.A
Closeable
that represents a change to the current context over a scope of code.A representation of stats measured on the server side.
Exception thrown when a
ServerStats
cannot be parsed.A service class to encode/decode
ServerStats
as defined by the spec.A Enum representation for Ids and Size for attributes of
ServerStats
.Available Ids for
ServerStats
attributes.Size for each attributes in
ServerStats
.An
EventQueue
that processes events in the current thread.An abstract class that represents a span.
Type of span.
Span
options.SpanBuilder
is used to construct Span
instances which define arbitrary scopes of
code that are sampled for distributed tracing as a single atomic unit.Implementation of the
SpanBuilder
.A class that represents a span context.
Exception thrown when a
SpanContext
cannot be parsed.Immutable representation of all data collected by the
Span
class.A set of attributes and the number of dropped attributes representation.
A list of links and the number of dropped links representation.
A timed event representation.
A list of timed events and the number of dropped events representation.
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()
).An abstract class that allows different tracing services to export recorded data for sampled
spans in their own format.
Implementation of the
SpanExporter
.A class that represents a span identifier.
Uses the provided
EventQueue
to defer processing/exporting of the SpanData
to
avoid impacting the critical path.Class for accessing the default
StatsComponent
.State of the
StatsComponent
.Class that holds the implementations for
ViewManager
and StatsRecorder
.Java 7 and 8 implementation of
StatsComponent
.Base implementation of
StatsComponent
.Android-compatible implementation of
StatsComponent
.Object that stores all views and stats.
Provides methods to record stats against tags.
Implementation of
StatsRecorder
.HTML page formatter for all exported
View
s.Defines the status of a
Span
by providing a standard Status.CanonicalCode
in conjunction
with an optional descriptive message.The set of canonical status codes.
Utility class to convert between
Status
and Status
.Internal utility methods for working with tag keys, tag values, and metric names.
Implementation of the
Distribution
as a summary of observations.Represents the summary observation of the recorded events over a sliding time window.
Represents the value at a given percentile of a distribution.
Object for serializing and deserializing
TagContext
s with the binary format.Builder for the
TagContext
class.Exception thrown when a
TagContext
cannot be parsed.Exception thrown when a
TagContext
cannot be serialized.Object for injecting and extracting
TagContext
as text into carriers that travel in-band
across process boundaries.Class that allows a
TagContextTextFormat
to read propagated fields from a carrier.Class that allows a
TagContextTextFormat
to set propagated fields into a carrier.Object for creating new
TagContext
s and TagContext
s based on the current context.Implementation of
Tagger
.State of the
TagsComponent
.A key to a value stored in a
TagContext
.Implementation of
TagContext
.TagMetadata
contains properties associated with a Tag
.TagMetadata.TagTtl
is an integer that represents number of hops a tag can propagate.Object containing all supported
TagContext
propagation formats.Implementation of
TagPropagationComponent
.Class for accessing the default
TagsComponent
.Class that holds the implementation for
Tagger
and TagPropagationComponent
.Java 7 and 8 implementation of
TagsComponent
.Base implementation of
TagsComponent
.Android-compatible implementation of
TagsComponent
.A validated tag value.
Internal helper class that holds a TagValue and a TagMetadata.
A
Clock
that allows the time to be set for testing.A
SpanExporter.Handler
for testing only.Injects and extracts
trace identifiers
as text into carriers that travel
in-band across process boundaries.Class that allows a
TextFormat
to read propagated fields from a carrier.Class that allows a
TextFormat
to set propagated fields into a carrier.Implementation of the
RandomHandler
using ThreadLocalRandom
.An abstract class that allows different tracing services to export recorded data for sampled
spans in their own format within a given time frame.
A collection of data points that describes the time-varying values of a
Metric
.A representation of an instant in time.
Represents a function that produces a double-valued result.
Represents a function that produces a long-valued result.
Class that holds the implementation instances for
Tracer
, PropagationComponent
,
Clock
, ExportComponent
and TraceConfig
.Java 7 and 8 implementation of the
TraceComponent
.Deprecated.
Helper class to allow sharing the code for all the
TraceComponent
implementations.Android-compatible implementation of the
TraceComponent
.Deprecated.
Global configuration of the trace service.
Global configuration of the trace service.
HTML page formatter for tracing config.
Implementation of the TraceContext propagation protocol.
A class that represents a trace identifier.
A class that represents global trace options.
Builder class for
TraceOptions
.Class that holds global trace parameters.
A
Builder
class for TraceParams
.Tracer is a simple, thin class for
Span
creation and in-process context interaction.Implementation of the
Tracer
.Carries tracing-system specific context in a list of key-value pairs.
Builder class for
MessageEvent
.Immutable key-value pair for
Tracestate
.HTML page formatter for tracing debug.
Class that manages a global instance of the
TraceComponent
.General internal utility methods.
General internal utility methods.
The actual point value for a
Point
.Value.ValueDistribution
contains summary statistics for a population of values.A 64-bit double-precision floating-point
Value
.A 64-bit integer
Value
.Value.ValueSummary
contains a snapshot representing values calculated over an arbitrary time
window.Common methods to encode and decode varints and varlongs into ByteBuffers and arrays.
A View specifies an aggregation and a set of tag keys.
Deprecated.
since 0.13.
Deprecated.
since 0.13.
Deprecated.
since 0.13.
The name of a
View
.The aggregated data for a particular
View
.Deprecated.
since 0.13, please use start and end
Timestamp
instead.Deprecated.
since 0.13, please use start and end
Timestamp
instead.Deprecated.
since 0.13, please use start and end
Timestamp
instead.Implementation of
ViewManager
.This class is a wrapper class for
WriteListener
.A
Clock
that always returns 0.Main interface for all the Z-Pages.
A collection of HTML pages to display stats and trace data and allow library configuration
control.
An
HttpHandler
that can be used to render HTML pages using any ZPageHandler
.
Aggregation.Distribution
instead.