Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- AbstractSpan - Class in org.opensearch.telemetry.tracing
-
Base span
- AbstractSpan(String, Span) - Constructor for class org.opensearch.telemetry.tracing.AbstractSpan
-
Base constructor
- add(double) - Method in interface org.opensearch.telemetry.metrics.Counter
-
add value.
- add(double) - Method in class org.opensearch.telemetry.metrics.noop.NoopCounter
- add(double, Tags) - Method in interface org.opensearch.telemetry.metrics.Counter
-
add value along with the attributes.
- add(double, Tags) - Method in class org.opensearch.telemetry.metrics.noop.NoopCounter
- addAttribute(String, boolean) - Method in class org.opensearch.telemetry.tracing.attributes.Attributes
-
Add boolean attribute.
- addAttribute(String, boolean) - Method in class org.opensearch.telemetry.tracing.noop.NoopScopedSpan
- addAttribute(String, boolean) - Method in interface org.opensearch.telemetry.tracing.ScopedSpan
-
Adds boolean attribute to the
Span. - addAttribute(String, double) - Method in class org.opensearch.telemetry.tracing.attributes.Attributes
-
Add double attribute.
- addAttribute(String, double) - Method in class org.opensearch.telemetry.tracing.noop.NoopScopedSpan
- addAttribute(String, double) - Method in interface org.opensearch.telemetry.tracing.ScopedSpan
-
Adds double attribute to the
Span. - addAttribute(String, long) - Method in class org.opensearch.telemetry.tracing.attributes.Attributes
-
Add long attribute.
- addAttribute(String, long) - Method in class org.opensearch.telemetry.tracing.noop.NoopScopedSpan
- addAttribute(String, long) - Method in interface org.opensearch.telemetry.tracing.ScopedSpan
-
Adds long attribute to the
Span. - addAttribute(String, Boolean) - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- addAttribute(String, Boolean) - Method in interface org.opensearch.telemetry.tracing.Span
-
Adds boolean type attribute in the span
- addAttribute(String, Double) - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- addAttribute(String, Double) - Method in interface org.opensearch.telemetry.tracing.Span
-
Adds double type attribute in the span
- addAttribute(String, Long) - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- addAttribute(String, Long) - Method in interface org.opensearch.telemetry.tracing.Span
-
Adds long type attribute in the span
- addAttribute(String, String) - Method in class org.opensearch.telemetry.tracing.attributes.Attributes
-
Add String attribute.
- addAttribute(String, String) - Method in class org.opensearch.telemetry.tracing.noop.NoopScopedSpan
- addAttribute(String, String) - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- addAttribute(String, String) - Method in interface org.opensearch.telemetry.tracing.ScopedSpan
-
Adds string attribute to the
Span. - addAttribute(String, String) - Method in interface org.opensearch.telemetry.tracing.Span
-
Adds string type attribute in the span
- addEvent(String) - Method in class org.opensearch.telemetry.tracing.noop.NoopScopedSpan
- addEvent(String) - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- addEvent(String) - Method in interface org.opensearch.telemetry.tracing.ScopedSpan
-
Adds an event to the
Span. - addEvent(String) - Method in interface org.opensearch.telemetry.tracing.Span
-
Adds an event in the span
- addTag(String, boolean) - Method in class org.opensearch.telemetry.metrics.tags.Tags
-
Add boolean attribute.
- addTag(String, double) - Method in class org.opensearch.telemetry.metrics.tags.Tags
-
Add double attribute.
- addTag(String, long) - Method in class org.opensearch.telemetry.metrics.tags.Tags
-
Add long attribute.
- addTag(String, String) - Method in class org.opensearch.telemetry.metrics.tags.Tags
-
Add String attribute.
- attach() - Method in class org.opensearch.telemetry.tracing.noop.NoopSpanScope
- attach() - Method in interface org.opensearch.telemetry.tracing.SpanScope
-
Attaches span to the
SpanScope - attributes(Attributes) - Method in class org.opensearch.telemetry.tracing.SpanCreationContext
-
Sets the span attributes.
- Attributes - Class in org.opensearch.telemetry.tracing.attributes
-
Class to create attributes for a span.
C
- client() - Static method in class org.opensearch.telemetry.tracing.SpanCreationContext
-
Sets the span type to client.
- CLIENT - Enum constant in enum class org.opensearch.telemetry.tracing.SpanKind
-
Span represents the client side code.
- close() - Method in class org.opensearch.telemetry.metrics.noop.NoopMetricsRegistry
- close() - Method in class org.opensearch.telemetry.tracing.noop.NoopScopedSpan
- close() - Method in class org.opensearch.telemetry.tracing.noop.NoopSpanScope
- close() - Method in class org.opensearch.telemetry.tracing.noop.NoopTracer
- close() - Method in interface org.opensearch.telemetry.tracing.ScopedSpan
-
closes the scope
- close() - Method in interface org.opensearch.telemetry.tracing.SpanScope
- Counter - Interface in org.opensearch.telemetry.metrics
-
Counter adds the value to the existing metric.
- create() - Static method in class org.opensearch.telemetry.metrics.tags.Tags
-
Factory method.
- create() - Static method in class org.opensearch.telemetry.tracing.attributes.Attributes
-
Factory method.
- create(double, Tags) - Static method in class org.opensearch.telemetry.metrics.TaggedMeasurement
-
Factory method to create the
TaggedMeasurementobject. - createCounter(String, String, String) - Method in interface org.opensearch.telemetry.metrics.MetricsRegistry
-
Creates the counter.
- createCounter(String, String, String) - Method in class org.opensearch.telemetry.metrics.noop.NoopMetricsRegistry
- createGauge(String, String, String, Supplier<Double>, Tags) - Method in interface org.opensearch.telemetry.metrics.MetricsRegistry
-
Creates the Observable Gauge type of Metric.
- createGauge(String, String, String, Supplier<Double>, Tags) - Method in class org.opensearch.telemetry.metrics.noop.NoopMetricsRegistry
- createGauge(String, String, String, Supplier<TaggedMeasurement>) - Method in interface org.opensearch.telemetry.metrics.MetricsRegistry
-
Creates the Observable Gauge type of Metric.
- createGauge(String, String, String, Supplier<TaggedMeasurement>) - Method in class org.opensearch.telemetry.metrics.noop.NoopMetricsRegistry
- createHistogram(String, String, String) - Method in interface org.opensearch.telemetry.metrics.MetricsRegistry
-
Creates the histogram type of Metric.
- createHistogram(String, String, String) - Method in class org.opensearch.telemetry.metrics.noop.NoopMetricsRegistry
- createSpan(SpanCreationContext, Span) - Method in interface org.opensearch.telemetry.tracing.TracingTelemetry
-
Creates span with provided arguments
- createUpDownCounter(String, String, String) - Method in interface org.opensearch.telemetry.metrics.MetricsRegistry
-
Creates the upDown counter.
- createUpDownCounter(String, String, String) - Method in class org.opensearch.telemetry.metrics.noop.NoopMetricsRegistry
- CURRENT_SPAN - Static variable in interface org.opensearch.telemetry.tracing.TracerContextStorage
-
Key for storing current span
E
- EMPTY - Static variable in class org.opensearch.telemetry.metrics.tags.Tags
-
Empty value.
- EMPTY - Static variable in class org.opensearch.telemetry.tracing.attributes.Attributes
-
Empty value.
- endSpan() - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- endSpan() - Method in interface org.opensearch.telemetry.tracing.Span
-
Ends the span
- endSpan() - Method in class org.opensearch.telemetry.tracing.SpanContext
-
Ends current span
- extract(Map<String, String>) - Method in interface org.opensearch.telemetry.tracing.TracingContextPropagator
-
Extracts current span from context
- extractFromHeaders(Map<String, Collection<String>>) - Method in interface org.opensearch.telemetry.tracing.TracingContextPropagator
-
Extracts current span from HTTP headers.
G
- get(K) - Method in interface org.opensearch.telemetry.tracing.TracerContextStorage
-
Fetches value corresponding to key
- getAttributes() - Method in class org.opensearch.telemetry.tracing.SpanCreationContext
-
Returns the span attributes.
- getAttributesMap() - Method in class org.opensearch.telemetry.tracing.attributes.Attributes
-
Returns the attribute map.
- getContextPropagator() - Method in interface org.opensearch.telemetry.tracing.TracingTelemetry
-
provides tracing context propagator
- getCurrentSpan() - Method in class org.opensearch.telemetry.tracing.noop.NoopTracer
- getCurrentSpan() - Method in interface org.opensearch.telemetry.tracing.Tracer
-
Returns the current span.
- getMetricsTelemetry() - Method in interface org.opensearch.telemetry.Telemetry
-
Provides metrics telemetry
- getParent() - Method in class org.opensearch.telemetry.tracing.SpanCreationContext
-
Returns the parent span
- getParentSpan() - Method in class org.opensearch.telemetry.tracing.AbstractSpan
- getParentSpan() - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- getParentSpan() - Method in interface org.opensearch.telemetry.tracing.Span
-
Returns span's parent span
- getSpan() - Method in class org.opensearch.telemetry.tracing.noop.NoopSpanScope
- getSpan() - Method in interface org.opensearch.telemetry.tracing.SpanScope
-
Returns span attached with the
SpanScope - getSpanId() - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- getSpanId() - Method in interface org.opensearch.telemetry.tracing.Span
-
Returns spanId of the span
- getSpanKind() - Method in class org.opensearch.telemetry.tracing.SpanCreationContext
-
Returns the span kind.
- getSpanName() - Method in class org.opensearch.telemetry.tracing.AbstractSpan
- getSpanName() - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- getSpanName() - Method in interface org.opensearch.telemetry.tracing.Span
-
Returns the name of the
Span - getSpanName() - Method in class org.opensearch.telemetry.tracing.SpanCreationContext
-
Returns the span name.
- getTags() - Method in class org.opensearch.telemetry.metrics.TaggedMeasurement
-
Returns the tags.
- getTagsMap() - Method in class org.opensearch.telemetry.metrics.tags.Tags
-
Returns the attribute map.
- getTraceId() - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- getTraceId() - Method in interface org.opensearch.telemetry.tracing.Span
-
Returns traceId of the span
- getTracingTelemetry() - Method in interface org.opensearch.telemetry.Telemetry
-
Provides tracing telemetry
- getValue() - Method in class org.opensearch.telemetry.metrics.TaggedMeasurement
-
Returns the value.
H
- Histogram - Interface in org.opensearch.telemetry.metrics
-
Histogram records the value for an existing metric.
I
- inject(Span, BiConsumer<String, String>) - Method in interface org.opensearch.telemetry.tracing.TracingContextPropagator
-
Injects tracing context
- INSTANCE - Static variable in class org.opensearch.telemetry.metrics.noop.NoopCounter
-
No-op Counter instance
- INSTANCE - Static variable in class org.opensearch.telemetry.metrics.noop.NoopHistogram
-
No-op Histogram instance
- INSTANCE - Static variable in class org.opensearch.telemetry.metrics.noop.NoopMetricsRegistry
-
No-op Meter instance
- INSTANCE - Static variable in class org.opensearch.telemetry.tracing.noop.NoopSpan
-
No-op Span instance
- INSTANCE - Static variable in class org.opensearch.telemetry.tracing.noop.NoopTracer
-
No-op Tracer instance
- internal() - Static method in class org.opensearch.telemetry.tracing.SpanCreationContext
-
Sets the span type to internal.
- INTERNAL - Enum constant in enum class org.opensearch.telemetry.tracing.SpanKind
-
Span represents the internal calls.
- isRecording() - Method in class org.opensearch.telemetry.tracing.noop.NoopTracer
- isRecording() - Method in interface org.opensearch.telemetry.tracing.Tracer
-
Tells if the traces are being recorded or not
M
- MetricsRegistry - Interface in org.opensearch.telemetry.metrics
-
MetricsRegistry helps in creating the metric instruments.
- MetricsTelemetry - Interface in org.opensearch.telemetry.metrics
-
Interface for metrics telemetry providers
N
- name(String) - Method in class org.opensearch.telemetry.tracing.SpanCreationContext
-
Sets the span name.
- NO_OP - Static variable in interface org.opensearch.telemetry.tracing.ScopedSpan
-
No-op Scope implementation
- NO_OP - Static variable in interface org.opensearch.telemetry.tracing.SpanScope
-
No-op Scope implementation
- NoopCounter - Class in org.opensearch.telemetry.metrics.noop
-
No-op
Counter - NoopHistogram - Class in org.opensearch.telemetry.metrics.noop
-
No-op
Histogram - NoopMetricsRegistry - Class in org.opensearch.telemetry.metrics.noop
-
No-op
MetricsRegistry - NoopScopedSpan - Class in org.opensearch.telemetry.tracing.noop
-
No-op implementation of SpanScope
- NoopScopedSpan() - Constructor for class org.opensearch.telemetry.tracing.noop.NoopScopedSpan
-
No-args constructor
- NoopSpan - Class in org.opensearch.telemetry.tracing.noop
-
No-op implementation of
Span - NoopSpanScope - Class in org.opensearch.telemetry.tracing.noop
-
No-op implementation of
SpanScope - NoopSpanScope() - Constructor for class org.opensearch.telemetry.tracing.noop.NoopSpanScope
-
Constructor.
- NoopTracer - Class in org.opensearch.telemetry.tracing.noop
-
No-op implementation of Tracer
O
- org.opensearch.telemetry - package org.opensearch.telemetry
-
Contains telemetry related classes
- org.opensearch.telemetry.metrics - package org.opensearch.telemetry.metrics
-
Contains metrics related classes
- org.opensearch.telemetry.metrics.noop - package org.opensearch.telemetry.metrics.noop
-
Contains metrics related classes
- org.opensearch.telemetry.metrics.tags - package org.opensearch.telemetry.metrics.tags
-
Contains metrics related classes
- org.opensearch.telemetry.tracing - package org.opensearch.telemetry.tracing
-
Contains tracing related classes
- org.opensearch.telemetry.tracing.attributes - package org.opensearch.telemetry.tracing.attributes
-
Contains attributes management
- org.opensearch.telemetry.tracing.noop - package org.opensearch.telemetry.tracing.noop
-
Contains No-op implementations
- org.opensearch.telemetry.tracing.runnable - package org.opensearch.telemetry.tracing.runnable
-
Contains tracing related classes
- org.opensearch.telemetry.tracing.transport - package org.opensearch.telemetry.tracing.transport
-
Contains HTTP or TCP transport related tracer capabilities
P
- parent(SpanContext) - Method in class org.opensearch.telemetry.tracing.SpanCreationContext
-
Sets the parent for span
- put(K, V) - Method in interface org.opensearch.telemetry.tracing.TracerContextStorage
-
Puts tracing context value with key
R
- record(double) - Method in interface org.opensearch.telemetry.metrics.Histogram
-
record value.
- record(double) - Method in class org.opensearch.telemetry.metrics.noop.NoopHistogram
- record(double, Tags) - Method in interface org.opensearch.telemetry.metrics.Histogram
-
record value along with the attributes.
- record(double, Tags) - Method in class org.opensearch.telemetry.metrics.noop.NoopHistogram
- run() - Method in class org.opensearch.telemetry.tracing.runnable.TraceableRunnable
S
- ScopedSpan - Interface in org.opensearch.telemetry.tracing
-
An auto-closeable that represents scoped span.
- server() - Static method in class org.opensearch.telemetry.tracing.SpanCreationContext
-
Sets the span type to server.
- SERVER - Enum constant in enum class org.opensearch.telemetry.tracing.SpanKind
-
Span represents the server side code.
- setError(Exception) - Method in class org.opensearch.telemetry.tracing.noop.NoopScopedSpan
- setError(Exception) - Method in class org.opensearch.telemetry.tracing.noop.NoopSpan
- setError(Exception) - Method in interface org.opensearch.telemetry.tracing.ScopedSpan
-
Records error in the span
- setError(Exception) - Method in interface org.opensearch.telemetry.tracing.Span
-
Records error in the span
- setError(Exception) - Method in class org.opensearch.telemetry.tracing.SpanContext
-
Sets the error for the current span behind this context
- Span - Interface in org.opensearch.telemetry.tracing
-
An interface that represents a tracing span.
- SpanContext - Class in org.opensearch.telemetry.tracing
-
Wrapped Span will be exposed to the code outside of tracing package for sharing the
Spanwithout having access to its properties. - SpanContext(Span) - Constructor for class org.opensearch.telemetry.tracing.SpanContext
-
Constructor.
- SpanCreationContext - Class in org.opensearch.telemetry.tracing
-
Context for span details.
- SpanKind - Enum Class in org.opensearch.telemetry.tracing
-
Type of Span.
- SpanScope - Interface in org.opensearch.telemetry.tracing
-
An auto-closeable that represents scope of the span.
- startScopedSpan(SpanCreationContext) - Method in class org.opensearch.telemetry.tracing.noop.NoopTracer
- startScopedSpan(SpanCreationContext) - Method in interface org.opensearch.telemetry.tracing.Tracer
-
Start the span and scoped it.
- startSpan(SpanCreationContext) - Method in class org.opensearch.telemetry.tracing.noop.NoopTracer
- startSpan(SpanCreationContext) - Method in interface org.opensearch.telemetry.tracing.Tracer
-
Starts the
Spanwith givenSpanCreationContext - startSpan(SpanCreationContext, Map<String, Collection<String>>) - Method in class org.opensearch.telemetry.tracing.noop.NoopTracer
- startSpan(SpanCreationContext, Map<String, Collection<String>>) - Method in interface org.opensearch.telemetry.tracing.transport.TransportTracer
-
Start the span with propagating the tracing info from the HttpRequest header.
T
- TaggedMeasurement - Class in org.opensearch.telemetry.metrics
-
Observable Measurement for the Asynchronous instruments.
- Tags - Class in org.opensearch.telemetry.metrics.tags
-
Class to create tags for a meter.
- Telemetry - Interface in org.opensearch.telemetry
-
Interface defining telemetry
- TraceableRunnable - Class in org.opensearch.telemetry.tracing.runnable
-
Wraps the runnable and add instrumentation to trace the
Runnable - TraceableRunnable(Tracer, SpanCreationContext, Runnable) - Constructor for class org.opensearch.telemetry.tracing.runnable.TraceableRunnable
-
Constructor.
- Tracer - Interface in org.opensearch.telemetry.tracing
-
Tracer is the interface used to create a
SpanIt automatically handles the context propagation between threads, tasks, nodes etc. - TracerContextStorage<K,
V> - Interface in org.opensearch.telemetry.tracing -
Storage interface used for storing tracing context
- TracingContextPropagator - Interface in org.opensearch.telemetry.tracing
-
Interface defining the tracing related context propagation
- TracingTelemetry - Interface in org.opensearch.telemetry.tracing
-
Interface for tracing telemetry providers
- TransportTracer - Interface in org.opensearch.telemetry.tracing.transport
-
TransportTracer helps in creating a
Spanwhich reads the incoming tracing information from the HTTP or TCP transport headers and propagate the span accordingly.
V
- valueOf(String) - Static method in enum class org.opensearch.telemetry.tracing.SpanKind
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class org.opensearch.telemetry.tracing.SpanKind
-
Returns an array containing the constants of this enum class, in the order they are declared.
W
- withSpanInScope(Span) - Method in class org.opensearch.telemetry.tracing.noop.NoopTracer
- withSpanInScope(Span) - Method in interface org.opensearch.telemetry.tracing.Tracer
-
Creates the Span Scope for a current thread.
All Classes and Interfaces|All Packages|Constant Field Values