Index

A C E F G H I K L M N O P R S T V W 
All Classes and Interfaces|All Packages|Constant Field Values

A

addHighCardinalityKeyValue(KeyValue) - Method in class io.micrometer.observation.Observation.Context
Adds a high cardinality key value - those will be appended to those fetched from the ObservationConvention.getHighCardinalityKeyValues(Context) method.
addHighCardinalityKeyValues(KeyValues) - Method in class io.micrometer.observation.Observation.Context
Adds multiple high cardinality key values at once.
addLowCardinalityKeyValue(KeyValue) - Method in class io.micrometer.observation.Observation.Context
Adds a low cardinality key value - those will be appended to those fetched from the ObservationConvention.getLowCardinalityKeyValues(Context) method.
addLowCardinalityKeyValues(KeyValues) - Method in class io.micrometer.observation.Observation.Context
Adds multiple low cardinality key values at once.
AllMatchingCompositeObservationHandler(ObservationHandler<? extends Observation.Context>...) - Constructor for class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
Creates a new instance of AllMatchingCompositeObservationHandler.
AllMatchingCompositeObservationHandler(List<? extends ObservationHandler<? extends Observation.Context>>) - Constructor for class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
Creates a new instance of AllMatchingCompositeObservationHandler.
apply(T) - Method in interface io.micrometer.observation.Observation.CheckedFunction
 

C

call() - Method in interface io.micrometer.observation.Observation.CheckedCallable
 
clear() - Method in class io.micrometer.observation.Observation.Context
Clears the entries from the context.
CLIENT - Enum constant in enum class io.micrometer.observation.transport.Kind
Indicates that the operation covers the client-side wrapper around an RPC or other remote request.
close() - Method in interface io.micrometer.observation.Observation.Scope
Clears the current scope and notifies the handlers that the scope was closed.
computeIfAbsent(Object, Function<Object, ? extends T>) - Method in class io.micrometer.observation.Observation.Context
Returns an element or calls a mapping function if entry not present.
CONSUMER - Enum constant in enum class io.micrometer.observation.transport.Kind
Indicates that the operation describes consumer receiving a message from a broker.
containsKey(Object) - Method in class io.micrometer.observation.Observation.Context
Checks if context contains a key.
containsKey(Object) - Method in interface io.micrometer.observation.Observation.ContextView
Checks if context contains a key.
Context() - Constructor for class io.micrometer.observation.Observation.Context
 
contextualName() - Element in annotation interface io.micrometer.observation.annotation.Observed
Contextual name of the Observation.
contextualName(String) - Method in interface io.micrometer.observation.Observation
Sets the name that can be defined from the contents of the context.
contextualName(String) - Method in class io.micrometer.observation.NullObservation
 
create() - Static method in interface io.micrometer.observation.ObservationRegistry
Creates an instance of ObservationRegistry.
createNotStarted(ObservationConvention<Observation.Context>, ObservationRegistry) - Static method in interface io.micrometer.observation.Observation
Creates but does not start an Observation.
createNotStarted(ObservationConvention<T>, ObservationConvention<T>, Supplier<T>, ObservationRegistry) - Static method in interface io.micrometer.observation.Observation
Creates but does not start an Observation.
createNotStarted(ObservationConvention<T>, Supplier<T>, ObservationRegistry) - Static method in interface io.micrometer.observation.Observation
Creates but does not start an Observation.
createNotStarted(String, ObservationRegistry) - Static method in interface io.micrometer.observation.Observation
Creates but does not start an Observation.
createNotStarted(String, Supplier<T>, ObservationRegistry) - Static method in interface io.micrometer.observation.Observation
Creates but does not start an Observation.

E

EMPTY - Static variable in interface io.micrometer.observation.docs.ObservationDocumentation
Empty key names.
EMPTY - Static variable in interface io.micrometer.observation.ObservationConvention
Empty instance of the convention.
EMPTY_EVENT_NAMES - Static variable in interface io.micrometer.observation.docs.ObservationDocumentation
Empty event names.
error(Throwable) - Method in interface io.micrometer.observation.Observation
Signals an error.
error(Throwable) - Method in class io.micrometer.observation.NullObservation
 
event(Observation.Event) - Method in interface io.micrometer.observation.Observation
Signals an arbitrary Observation.Event.
event(Observation.Event) - Method in class io.micrometer.observation.NullObservation
 

F

FirstMatchingCompositeObservationHandler(ObservationHandler<? extends Observation.Context>...) - Constructor for class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
Creates a new instance of FirstMatchingCompositeObservationHandler.
FirstMatchingCompositeObservationHandler(List<? extends ObservationHandler<? extends Observation.Context>>) - Constructor for class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
Creates a new instance of FirstMatchingCompositeObservationHandler.
format(Object...) - Method in interface io.micrometer.observation.Observation.Event
Creates a new event with the given dynamic entries for the contextual name.

G

get(C, String) - Method in interface io.micrometer.observation.transport.Propagator.Getter
Returns the first value of the given propagation key or returns null.
get(Object) - Method in class io.micrometer.observation.Observation.Context
Gets an entry from the context.
get(Object) - Method in interface io.micrometer.observation.Observation.ContextView
Gets an entry from the context.
getAllKeyValues() - Method in class io.micrometer.observation.Observation.Context
 
getAllKeyValues() - Method in interface io.micrometer.observation.Observation.ContextView
Returns all key values.
getCarrier() - Method in class io.micrometer.observation.transport.ReceiverContext
 
getCarrier() - Method in class io.micrometer.observation.transport.SenderContext
 
getContext() - Method in interface io.micrometer.observation.Observation
Returns the context attached to this observation.
getContext() - Method in class io.micrometer.observation.NullObservation
 
getContextualName() - Method in interface io.micrometer.observation.docs.ObservationDocumentation
More human-readable name available within the given context (e.g.: span name).
getContextualName() - Method in class io.micrometer.observation.Observation.Context
Returns the contextual name.
getContextualName() - Method in interface io.micrometer.observation.Observation.ContextView
Returns the contextual name.
getContextualName() - Method in interface io.micrometer.observation.Observation.Event
Returns the contextual name of the event.
getContextualName(T) - Method in interface io.micrometer.observation.ObservationConvention
Allows to override the contextual name for an Observation.
getContextView() - Method in interface io.micrometer.observation.Observation
Returns the context attached to this observation as a read only view.
getContextView() - Method in interface io.micrometer.observation.ObservationView
Returns the Observation.ContextView attached to this observation.
getCurrentObservation() - Method in interface io.micrometer.observation.Observation.Scope
Current observation available within this scope.
getCurrentObservation() - Method in interface io.micrometer.observation.ObservationRegistry
When previously set will allow to retrieve the Observation at any point in time.
getCurrentObservationScope() - Method in interface io.micrometer.observation.ObservationRegistry
When previously set will allow to retrieve the Observation.Scope at any point in time.
getDefaultConvention() - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Default naming convention (sets technical and contextual names, and key values).
getEnclosingScope() - Method in interface io.micrometer.observation.ObservationView
Pops the last scope attached to this ObservationView in this thread.
getEnclosingScope() - Method in class io.micrometer.observation.NullObservation
 
getError() - Method in class io.micrometer.observation.Observation.Context
Error that occurred while processing the Observation.
getError() - Method in interface io.micrometer.observation.Observation.ContextView
Error that occurred while processing the Observation.
getEvents() - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Event values.
getGetter() - Method in class io.micrometer.observation.transport.ReceiverContext
 
getHandlers() - Method in class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
 
getHandlers() - Method in interface io.micrometer.observation.ObservationHandler.CompositeObservationHandler
Returns the registered handlers.
getHandlers() - Method in class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
 
getHighCardinalityKeyNames() - Method in interface io.micrometer.observation.docs.ObservationDocumentation
High cardinality key names.
getHighCardinalityKeyValue(String) - Method in class io.micrometer.observation.Observation.Context
 
getHighCardinalityKeyValue(String) - Method in interface io.micrometer.observation.Observation.ContextView
Returns a high cardinality key value or null if not present.
getHighCardinalityKeyValues() - Method in class io.micrometer.observation.Observation.Context
 
getHighCardinalityKeyValues() - Method in interface io.micrometer.observation.Observation.ContextView
Returns high cardinality key values.
getHighCardinalityKeyValues(T) - Method in interface io.micrometer.observation.ObservationConvention
High cardinality key values.
getInstance() - Static method in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
Return the singleton instance of this ObservationThreadLocalAccessor.
getKind() - Method in class io.micrometer.observation.transport.ReceiverContext
 
getKind() - Method in class io.micrometer.observation.transport.SenderContext
 
getLowCardinalityKeyNames() - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Low cardinality key names.
getLowCardinalityKeyValue(String) - Method in class io.micrometer.observation.Observation.Context
 
getLowCardinalityKeyValue(String) - Method in interface io.micrometer.observation.Observation.ContextView
Returns a low cardinality key value or null if not present.
getLowCardinalityKeyValues() - Method in class io.micrometer.observation.Observation.Context
 
getLowCardinalityKeyValues() - Method in interface io.micrometer.observation.Observation.ContextView
Returns low cardinality key values.
getLowCardinalityKeyValues(T) - Method in interface io.micrometer.observation.ObservationConvention
Low cardinality key values.
getName() - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Default technical name (e.g.: metric name).
getName() - Method in class io.micrometer.observation.Observation.Context
The observation name.
getName() - Method in interface io.micrometer.observation.Observation.ContextView
The observation name.
getName() - Method in interface io.micrometer.observation.Observation.Event
Returns the name of the event.
getName() - Method in interface io.micrometer.observation.ObservationConvention
Allows to override the name for an observation.
getObservationRegistry() - Method in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
Returns the provided ObservationRegistry.
getObservationRegistry() - Method in interface io.micrometer.observation.ObservationView
Returns the ObservationRegistry attached to this observation.
getObservationRegistry() - Method in class io.micrometer.observation.NullObservation
 
getOrDefault(Object, Supplier<T>) - Method in interface io.micrometer.observation.Observation.ContextView
Returns an element or default if not present.
getOrDefault(Object, T) - Method in class io.micrometer.observation.Observation.Context
Returns an element or default if not present.
getOrDefault(Object, T) - Method in interface io.micrometer.observation.Observation.ContextView
Returns an element or default if not present.
getParentObservation() - Method in class io.micrometer.observation.Observation.Context
Returns the parent ObservationView.
getParentObservation() - Method in interface io.micrometer.observation.Observation.ContextView
Returns the parent ObservationView.
getPrefix() - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Returns required prefix to be there for tags.
getPreviousObservationScope() - Method in interface io.micrometer.observation.Observation.Scope
Parent scope.
getProceedingJoinPoint() - Method in class io.micrometer.observation.aop.ObservedAspect.ObservedAspectContext
 
getRemoteServiceAddress() - Method in class io.micrometer.observation.transport.ReceiverContext
Return optional address for the service that will be called.
getRemoteServiceAddress() - Method in class io.micrometer.observation.transport.SenderContext
Return optional address for the service that will be called.
getRemoteServiceName() - Method in class io.micrometer.observation.transport.ReceiverContext
Return optional name for the service from which the message is polled.
getRemoteServiceName() - Method in class io.micrometer.observation.transport.SenderContext
Return optional name for the service that will be called.
getRequired(Object) - Method in class io.micrometer.observation.Observation.Context
Gets an entry from the context.
getRequired(Object) - Method in interface io.micrometer.observation.Observation.ContextView
Gets an entry from the context.
getResponse() - Method in class io.micrometer.observation.transport.RequestReplyReceiverContext
 
getResponse() - Method in class io.micrometer.observation.transport.RequestReplySenderContext
 
getResponse() - Method in interface io.micrometer.observation.transport.ResponseContext
Getter for the response object.
getSetter() - Method in class io.micrometer.observation.transport.SenderContext
 
getValue() - Method in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
 
getWallTime() - Method in interface io.micrometer.observation.Observation.Event
Wall time in milliseconds since the epoch.
GlobalObservationConvention<T> - Interface in io.micrometer.observation
An observation convention that will be set on the ObservationRegistry.

H

highCardinalityKeyValue(KeyValue) - Method in interface io.micrometer.observation.Observation
Adds a high cardinality key value.
highCardinalityKeyValue(KeyValue) - Method in class io.micrometer.observation.NullObservation
 
highCardinalityKeyValue(String, String) - Method in interface io.micrometer.observation.Observation
Adds a high cardinality key value.
highCardinalityKeyValues(KeyValues) - Method in interface io.micrometer.observation.Observation
Adds multiple high cardinality key value instances.

I

io.micrometer.observation - package io.micrometer.observation
 
io.micrometer.observation.annotation - package io.micrometer.observation.annotation
 
io.micrometer.observation.aop - package io.micrometer.observation.aop
 
io.micrometer.observation.contextpropagation - package io.micrometer.observation.contextpropagation
 
io.micrometer.observation.docs - package io.micrometer.observation.docs
 
io.micrometer.observation.transport - package io.micrometer.observation.transport
 
isNoop() - Method in interface io.micrometer.observation.Observation
Checks whether this Observation is no-op.
isNoop() - Method in interface io.micrometer.observation.Observation.Scope
Checks whether this Observation.Scope is no-op.
isNoop() - Method in interface io.micrometer.observation.ObservationRegistry
Checks whether this ObservationRegistry is no-op.

K

key() - Method in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
 
KEY - Static variable in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
Key under which Micrometer Observation is being registered.
KeyValuesConvention - Interface in io.micrometer.observation
A marker interface for conventions of KeyValues naming.
Kind - Enum Class in io.micrometer.observation.transport
Represents side of communication.

L

lowCardinalityKeyValue(KeyValue) - Method in interface io.micrometer.observation.Observation
Adds a low cardinality key value.
lowCardinalityKeyValue(KeyValue) - Method in class io.micrometer.observation.NullObservation
 
lowCardinalityKeyValue(String, String) - Method in interface io.micrometer.observation.Observation
Adds a low cardinality key value.
lowCardinalityKeyValues() - Element in annotation interface io.micrometer.observation.annotation.Observed
Low cardinality key values.
lowCardinalityKeyValues(KeyValues) - Method in interface io.micrometer.observation.Observation
Adds multiple low cardinality key value instances.

M

makeCurrent() - Method in interface io.micrometer.observation.Observation.Scope
This method assumes that all previous scopes got Observation.Scope.reset().
map(Observation.Context) - Method in interface io.micrometer.observation.ObservationFilter
Mutates the Observation.Context.

N

name() - Element in annotation interface io.micrometer.observation.annotation.Observed
Name of the Observation.
NOOP - Static variable in interface io.micrometer.observation.Observation
No-op observation.
NOOP - Static variable in interface io.micrometer.observation.Observation.Scope
No-op scope.
NOOP - Static variable in interface io.micrometer.observation.ObservationRegistry
No-op implementation of ObservationRegistry.
NullObservation - Class in io.micrometer.observation
A special Observation that should be used only in special cases where clearing of scopes is important.
NullObservation(ObservationRegistry) - Constructor for class io.micrometer.observation.NullObservation
 

O

observation(ObservationConvention<T>, ObservationConvention<T>, Supplier<T>, ObservationRegistry) - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Creates an Observation for the given ObservationConvention.
observation(ObservationRegistry) - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Creates an Observation.
observation(ObservationRegistry, Supplier<Observation.Context>) - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Creates an Observation.
Observation - Interface in io.micrometer.observation
An act of viewing or noticing a fact or an occurrence for some scientific or other special purpose (According to dictionary.com).
Observation.CheckedCallable<T,E> - Interface in io.micrometer.observation
A functional interface like Callable but it can throw a Throwable.
Observation.CheckedFunction<T,R,E> - Interface in io.micrometer.observation
A functional interface like Function but it can throw a Throwable.
Observation.CheckedRunnable<E> - Interface in io.micrometer.observation
A functional interface like Runnable but it can throw a Throwable.
Observation.Context - Class in io.micrometer.observation
A mutable holder of data required by an ObservationHandler.
Observation.ContextView - Interface in io.micrometer.observation
Read only view on the Observation.Context.
Observation.Event - Interface in io.micrometer.observation
An arbitrary event that you can extend and signal during an Observation.
Observation.Scope - Interface in io.micrometer.observation
Scope represent an action within which certain resources (e.g.
observationConfig() - Method in interface io.micrometer.observation.ObservationRegistry
Configuration options for this registry.
ObservationConfig() - Constructor for class io.micrometer.observation.ObservationRegistry.ObservationConfig
 
observationConvention(GlobalObservationConvention<?>) - Method in class io.micrometer.observation.ObservationRegistry.ObservationConfig
observationConvention(ObservationConvention<?>) - Method in interface io.micrometer.observation.Observation
Sets an observation convention that can be used to attach key values to the observation.
observationConvention(ObservationConvention<?>) - Method in class io.micrometer.observation.NullObservation
 
ObservationConvention<T> - Interface in io.micrometer.observation
Contains conventions for naming and KeyValues providing.
ObservationDocumentation - Interface in io.micrometer.observation.docs
In order to describe your samples via e.g.
observationFilter(ObservationFilter) - Method in class io.micrometer.observation.ObservationRegistry.ObservationConfig
Register an observation filter for the observations.
ObservationFilter - Interface in io.micrometer.observation
Allows to modify the Observation.Context on stopping the Observation before the ObservationHandler implementations process it.
observationHandler(ObservationHandler<?>) - Method in class io.micrometer.observation.ObservationRegistry.ObservationConfig
Register a handler for the observations.
ObservationHandler<T> - Interface in io.micrometer.observation
Handler for an Observation.
ObservationHandler.AllMatchingCompositeObservationHandler - Class in io.micrometer.observation
Handler picking all matching handlers from the list.
ObservationHandler.CompositeObservationHandler - Interface in io.micrometer.observation
Handler wrapping other handlers.
ObservationHandler.FirstMatchingCompositeObservationHandler - Class in io.micrometer.observation
Handler picking the first matching handler from the list.
observationPredicate(ObservationPredicate) - Method in class io.micrometer.observation.ObservationRegistry.ObservationConfig
Register a predicate to define whether observation should be created or a NoopObservation instead.
ObservationPredicate - Interface in io.micrometer.observation
A predicate to define whether observation should be created or a NoopObservation instead.
ObservationRegistry - Interface in io.micrometer.observation
Implementations of this interface are responsible for managing state of an Observation.
ObservationRegistry.ObservationConfig - Class in io.micrometer.observation
Access to configuration options for this registry.
ObservationTextPublisher - Class in io.micrometer.observation
An ObservationHandler that converts the context to text and publishes it to the Consumer of your choice.
ObservationTextPublisher() - Constructor for class io.micrometer.observation.ObservationTextPublisher
Creates a publisher that sends the context as text to the given Consumer.
ObservationTextPublisher(Consumer<String>) - Constructor for class io.micrometer.observation.ObservationTextPublisher
Creates a publisher that sends the context as text to the given Consumer.
ObservationTextPublisher(Consumer<String>, Predicate<Observation.Context>) - Constructor for class io.micrometer.observation.ObservationTextPublisher
Creates a publisher that sends the context as text to the given Consumer if the Predicate returns true.
ObservationTextPublisher(Consumer<String>, Predicate<Observation.Context>, Function<Observation.Context, String>) - Constructor for class io.micrometer.observation.ObservationTextPublisher
Creates a publisher that sends the context as text to the given Consumer if the Predicate returns true.
ObservationThreadLocalAccessor - Class in io.micrometer.observation.contextpropagation
A ThreadLocalAccessor to put and restore current Observation.
ObservationThreadLocalAccessor() - Constructor for class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
Creates a new instance of this class and stores a static handle to it.
ObservationThreadLocalAccessor(ObservationRegistry) - Constructor for class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
Creates a new instance of this class.
ObservationView - Interface in io.micrometer.observation
Read only view on the Observation.
observe(Runnable) - Method in interface io.micrometer.observation.Observation
Observes the passed Runnable, this means the followings: Starts the Observation Opens a Scope Calls Runnable.run() Closes the Scope Signals the error to the Observation if any Stops the Observation
observe(Supplier<T>) - Method in interface io.micrometer.observation.Observation
Observes the passed Supplier, this means the followings: Starts the Observation Opens a Scope Calls Supplier.get() Closes the Scope Signals the error to the Observation if any Stops the Observation
observeChecked(Observation.CheckedCallable<T, E>) - Method in interface io.micrometer.observation.Observation
Observes the passed Observation.CheckedCallable, this means the followings: Starts the Observation Opens a Scope Calls Observation.CheckedCallable.call() Closes the Scope Signals the error to the Observation if any Stops the Observation
observeChecked(Observation.CheckedRunnable<E>) - Method in interface io.micrometer.observation.Observation
Observes the passed Observation.CheckedRunnable, this means the followings: Starts the Observation Opens a Scope Calls Observation.CheckedRunnable.run() Closes the Scope Signals the error to the Observation if any Stops the Observation
observeCheckedWithContext(Observation.CheckedFunction<C, T, E>) - Method in interface io.micrometer.observation.Observation
Deprecated.
scheduled for removal in 1.15.0, use observeChecked(...) directly
observeClass(ProceedingJoinPoint) - Method in class io.micrometer.observation.aop.ObservedAspect
 
Observed - Annotation Interface in io.micrometer.observation.annotation
Annotated methods are instrumented using an Observation.
ObservedAspect - Class in io.micrometer.observation.aop
AspectJ aspect for intercepting types or methods annotated with @Observed.
The aspect supports programmatic customizations through constructor-injectable custom logic.
ObservedAspect(ObservationRegistry) - Constructor for class io.micrometer.observation.aop.ObservedAspect
 
ObservedAspect(ObservationRegistry, ObservationConvention<ObservedAspect.ObservedAspectContext>) - Constructor for class io.micrometer.observation.aop.ObservedAspect
 
ObservedAspect(ObservationRegistry, ObservationConvention<ObservedAspect.ObservedAspectContext>, Predicate<ProceedingJoinPoint>) - Constructor for class io.micrometer.observation.aop.ObservedAspect
 
ObservedAspect(ObservationRegistry, Predicate<ProceedingJoinPoint>) - Constructor for class io.micrometer.observation.aop.ObservedAspect
 
ObservedAspect.ObservedAspectContext - Class in io.micrometer.observation.aop
 
ObservedAspectContext(ProceedingJoinPoint) - Constructor for class io.micrometer.observation.aop.ObservedAspect.ObservedAspectContext
 
observeMethod(ProceedingJoinPoint) - Method in class io.micrometer.observation.aop.ObservedAspect
 
observeWithContext(Function<C, T>) - Method in interface io.micrometer.observation.Observation
Deprecated.
scheduled for removal in 1.15.0, use observe(...) directly
of(String) - Static method in interface io.micrometer.observation.Observation.Event
Creates an Observation.Event for the given name.
of(String, String) - Static method in interface io.micrometer.observation.Observation.Event
Creates an Observation.Event for the given names.
of(String, String, long) - Static method in interface io.micrometer.observation.Observation.Event
Creates an Observation.Event for the given names and timestamp (wall time).
onError(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
 
onError(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
 
onError(Observation.Context) - Method in class io.micrometer.observation.ObservationTextPublisher
 
onError(T) - Method in interface io.micrometer.observation.ObservationHandler
Reacts to an error during an Observation.
onEvent(Observation.Event, Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
 
onEvent(Observation.Event, Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
 
onEvent(Observation.Event, Observation.Context) - Method in class io.micrometer.observation.ObservationTextPublisher
 
onEvent(Observation.Event, T) - Method in interface io.micrometer.observation.ObservationHandler
Reacts to arbitrary Observation.Event.
onScopeClosed(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
 
onScopeClosed(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
 
onScopeClosed(Observation.Context) - Method in class io.micrometer.observation.ObservationTextPublisher
 
onScopeClosed(T) - Method in interface io.micrometer.observation.ObservationHandler
Reacts to closing of an Observation.Scope.
onScopeOpened(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
 
onScopeOpened(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
 
onScopeOpened(Observation.Context) - Method in class io.micrometer.observation.ObservationTextPublisher
 
onScopeOpened(T) - Method in interface io.micrometer.observation.ObservationHandler
Reacts to opening of an Observation.Scope.
onScopeReset(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
 
onScopeReset(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
 
onScopeReset(T) - Method in interface io.micrometer.observation.ObservationHandler
Reacts to resetting of scopes.
onStart(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
 
onStart(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
 
onStart(Observation.Context) - Method in class io.micrometer.observation.ObservationTextPublisher
 
onStart(T) - Method in interface io.micrometer.observation.ObservationHandler
Reacts to starting of an Observation.
onStop(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
 
onStop(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
 
onStop(Observation.Context) - Method in class io.micrometer.observation.ObservationTextPublisher
 
onStop(T) - Method in interface io.micrometer.observation.ObservationHandler
Reacts to stopping of an Observation.
openScope() - Method in interface io.micrometer.observation.Observation
When put in scope, additional operations can take place by the ObservationHandlers such as putting entries in thread local.
openScope() - Method in class io.micrometer.observation.NullObservation
 

P

parentObservation(Observation) - Method in interface io.micrometer.observation.Observation
If you have access to a previously created Observation you can manually set the parent Observation using this method - that way you won't need to open scopes just to create a child observation.
parentObservation(Observation) - Method in class io.micrometer.observation.NullObservation
 
PRODUCER - Enum constant in enum class io.micrometer.observation.transport.Kind
Indicates that the operation describes producer sending a message to a broker.
Propagator - Interface in io.micrometer.observation.transport
Inspired by OpenZipkin Brave and OpenTelemetry.
Propagator.Getter<C> - Interface in io.micrometer.observation.transport
Interface that allows to read propagated fields from a carrier.
Propagator.Setter<C> - Interface in io.micrometer.observation.transport
Class that allows to set propagated fields into a carrier.
put(Object, T) - Method in class io.micrometer.observation.Observation.Context
Puts an element to the context.

R

ReceiverContext<C> - Class in io.micrometer.observation.transport
Context used when receiving data over the wire without requiring any confirmation to be sent to sender of the data.
ReceiverContext(Propagator.Getter<C>) - Constructor for class io.micrometer.observation.transport.ReceiverContext
Creates a new instance of a Kind.CONSUMER ReceiverContext.
ReceiverContext(Propagator.Getter<C>, Kind) - Constructor for class io.micrometer.observation.transport.ReceiverContext
Creates a new instance of ReceiverContext.
remove(Object) - Method in class io.micrometer.observation.Observation.Context
Removes an entry from the context.
removeHighCardinalityKeyValue(String) - Method in class io.micrometer.observation.Observation.Context
Removes a high cardinality key value by looking at its key - those will be removed to those fetched from the ObservationConvention.getHighCardinalityKeyValues(Context) method.
removeHighCardinalityKeyValues(String...) - Method in class io.micrometer.observation.Observation.Context
Removes multiple high cardinality key values at once.
removeLowCardinalityKeyValue(String) - Method in class io.micrometer.observation.Observation.Context
Removes a low cardinality key value by looking at its key - those will be removed to those fetched from the ObservationConvention.getLowCardinalityKeyValues(Context) method.
removeLowCardinalityKeyValues(String...) - Method in class io.micrometer.observation.Observation.Context
Removes multiple low cardinality key values at once.
RequestReplyReceiverContext<C,RES> - Class in io.micrometer.observation.transport
Context used when receiving data over the wire with confirmation to be sent to sender of the data.
RequestReplyReceiverContext(Propagator.Getter<C>) - Constructor for class io.micrometer.observation.transport.RequestReplyReceiverContext
Creates a new instance of Kind.SERVER RequestReplyReceiverContext.
RequestReplyReceiverContext(Propagator.Getter<C>, Kind) - Constructor for class io.micrometer.observation.transport.RequestReplyReceiverContext
Creates a new instance of RequestReplyReceiverContext.
RequestReplySenderContext<C,RES> - Class in io.micrometer.observation.transport
Context used when sending data over the wire with the idea that you'll wait for some response from the recipient.
RequestReplySenderContext(Propagator.Setter<C>) - Constructor for class io.micrometer.observation.transport.RequestReplySenderContext
Creates a new instance of a Kind.CLIENT RequestReplySenderContext.
RequestReplySenderContext(Propagator.Setter<C>, Kind) - Constructor for class io.micrometer.observation.transport.RequestReplySenderContext
Creates a new instance of RequestReplySenderContext.
reset() - Method in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
Deprecated.
reset() - Method in interface io.micrometer.observation.Observation.Scope
Resets the current scope.
ResponseContext<RES> - Interface in io.micrometer.observation.transport
Common interface for getting/setting the response object on Observation.Context implementations that handle a response.
restore() - Method in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
 
restore(Observation) - Method in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
 
run() - Method in interface io.micrometer.observation.Observation.CheckedRunnable
 

S

scoped(Runnable) - Method in interface io.micrometer.observation.Observation
Wraps the given action in a scope and signals an error.
scoped(Supplier<T>) - Method in interface io.micrometer.observation.Observation
Wraps the given action in a scope and signals an error.
scopedChecked(Observation.CheckedCallable<T, E>) - Method in interface io.micrometer.observation.Observation
Wraps the given action in a scope and signals an error.
scopedChecked(Observation.CheckedRunnable<E>) - Method in interface io.micrometer.observation.Observation
Wraps the given action in a scope and signals an error.
SenderContext<C> - Class in io.micrometer.observation.transport
Context used when sending data over the wire in a fire and forget fashion.
SenderContext(Propagator.Setter<C>) - Constructor for class io.micrometer.observation.transport.SenderContext
Creates a new instance of a Kind.PRODUCER SenderContext.
SenderContext(Propagator.Setter<C>, Kind) - Constructor for class io.micrometer.observation.transport.SenderContext
Creates a new instance of SenderContext.
SERVER - Enum constant in enum class io.micrometer.observation.transport.Kind
Indicates that the operation covers server-side handling of an RPC or other remote request.
set(C, String, String) - Method in interface io.micrometer.observation.transport.Propagator.Setter
Replaces a propagated field with the given value.
setCarrier(C) - Method in class io.micrometer.observation.transport.ReceiverContext
 
setCarrier(C) - Method in class io.micrometer.observation.transport.SenderContext
 
setContextualName(String) - Method in class io.micrometer.observation.Observation.Context
Sets the contextual name.
setCurrentObservationScope(Observation.Scope) - Method in interface io.micrometer.observation.ObservationRegistry
Sets the observation scope as current.
setError(Throwable) - Method in class io.micrometer.observation.Observation.Context
Sets an error that occurred while processing the Observation.
setName(String) - Method in class io.micrometer.observation.Observation.Context
Sets the observation name.
setObservationRegistry(ObservationRegistry) - Method in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
Provide an ObservationRegistry to be used by ObservationThreadLocalAccessor.
setParentObservation(ObservationView) - Method in class io.micrometer.observation.Observation.Context
Sets the parent ObservationView.
setRemoteServiceAddress(String) - Method in class io.micrometer.observation.transport.ReceiverContext
Set optional service address for the service that will be called.
setRemoteServiceAddress(String) - Method in class io.micrometer.observation.transport.SenderContext
Set optional service address for the service that will be called.
setRemoteServiceName(String) - Method in class io.micrometer.observation.transport.ReceiverContext
Set optional name for the service from which the message is polled.
setRemoteServiceName(String) - Method in class io.micrometer.observation.transport.SenderContext
Set optional name for the service that will be called.
setResponse(RES) - Method in class io.micrometer.observation.transport.RequestReplyReceiverContext
 
setResponse(RES) - Method in class io.micrometer.observation.transport.RequestReplySenderContext
 
setResponse(RES) - Method in interface io.micrometer.observation.transport.ResponseContext
Setter for the response object.
setValue() - Method in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
 
setValue(Observation) - Method in class io.micrometer.observation.contextpropagation.ObservationThreadLocalAccessor
 
start() - Method in class io.micrometer.observation.NullObservation
 
start() - Method in interface io.micrometer.observation.Observation
Starts the observation.
start(ObservationConvention<Observation.Context>, ObservationRegistry) - Static method in interface io.micrometer.observation.Observation
Creates and starts an Observation.
start(ObservationConvention<T>, ObservationConvention<T>, Supplier<T>, ObservationRegistry) - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Creates and starts an Observation.
start(ObservationConvention<T>, ObservationConvention<T>, Supplier<T>, ObservationRegistry) - Static method in interface io.micrometer.observation.Observation
Creates and starts an Observation.
start(ObservationConvention<T>, Supplier<T>, ObservationRegistry) - Static method in interface io.micrometer.observation.Observation
Creates and starts an Observation.
start(ObservationRegistry) - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Creates and starts an Observation.
start(ObservationRegistry, Supplier<Observation.Context>) - Method in interface io.micrometer.observation.docs.ObservationDocumentation
Creates and starts an Observation.
start(String, ObservationRegistry) - Static method in interface io.micrometer.observation.Observation
Create and start an Observation with the given name.
start(String, Supplier<T>, ObservationRegistry) - Static method in interface io.micrometer.observation.Observation
Creates and starts an Observation.
stop() - Method in interface io.micrometer.observation.Observation
Stop the observation.
stop() - Method in class io.micrometer.observation.NullObservation
 
supportsContext(Observation.Context) - Method in interface io.micrometer.observation.ObservationConvention
Tells whether this observation convention should be applied for a given Observation.Context.
supportsContext(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.AllMatchingCompositeObservationHandler
 
supportsContext(Observation.Context) - Method in class io.micrometer.observation.ObservationHandler.FirstMatchingCompositeObservationHandler
 
supportsContext(Observation.Context) - Method in interface io.micrometer.observation.ObservationHandler
Tells the registry whether this handler should be applied for a given Observation.Context.
supportsContext(Observation.Context) - Method in class io.micrometer.observation.ObservationTextPublisher
 

T

toString() - Method in class io.micrometer.observation.Observation.Context
 
toString() - Method in class io.micrometer.observation.NullObservation
 
tryScoped(Observation, Runnable) - Static method in interface io.micrometer.observation.Observation
Tries to run the action against an Observation.
tryScoped(Observation, Supplier<T>) - Static method in interface io.micrometer.observation.Observation
Tries to run the action against an Observation.
tryScopedChecked(Observation, Observation.CheckedCallable<T, E>) - Static method in interface io.micrometer.observation.Observation
Tries to run the action against an Observation.
tryScopedChecked(Observation, Observation.CheckedRunnable<E>) - Static method in interface io.micrometer.observation.Observation
Tries to run the action against an Observation.

V

valueOf(String) - Static method in enum class io.micrometer.observation.transport.Kind
Returns the enum constant of this class with the specified name.
values() - Static method in enum class io.micrometer.observation.transport.Kind
Returns an array containing the constants of this enum class, in the order they are declared.

W

wrap(Runnable) - Method in interface io.micrometer.observation.Observation
 
wrap(Supplier<T>) - Method in interface io.micrometer.observation.Observation
 
wrapChecked(Observation.CheckedCallable<T, E>) - Method in interface io.micrometer.observation.Observation
 
wrapChecked(Observation.CheckedRunnable<E>) - Method in interface io.micrometer.observation.Observation
 
A C E F G H I K L M N O P R S T V W 
All Classes and Interfaces|All Packages|Constant Field Values