public class MicrometerObservationCollectorBuilder extends Object
ObservationCollector
.Constructor and Description |
---|
MicrometerObservationCollectorBuilder() |
public MicrometerObservationCollectorBuilder()
public MicrometerObservationCollectorBuilder registry(io.micrometer.observation.ObservationRegistry registry)
ObservationRegistry
to use.
Default is ObservationRegistry.NOOP
.
registry
- the registrypublic MicrometerObservationCollectorBuilder customPublishObservationConvention(PublishObservationConvention customPublishObservationConvention)
basic.publish
.
If not null, it will override any pre-configured conventions.
Default is null
.
customPublishObservationConvention
- the conventionObservationDocumentation.observation(ObservationConvention,
ObservationConvention, Supplier, ObservationRegistry)
public MicrometerObservationCollectorBuilder defaultPublishObservationConvention(PublishObservationConvention defaultPublishObservationConvention)
basic.publish
.
It will be picked if there was neither custom convention nor a pre-configured one via ObservationRegistry
.
Default is DefaultPublishObservationConvention
.
defaultPublishObservationConvention
- the conventionObservationDocumentation.observation(ObservationConvention,
ObservationConvention, Supplier, ObservationRegistry)
public MicrometerObservationCollectorBuilder customProcessObservationConvention(DeliverObservationConvention customProcessObservationConvention)
basic.deliver
.
If not null, it will override any pre-configured conventions.
Default is null
.
customProcessObservationConvention
- the conventionObservationDocumentation.observation(ObservationConvention,
ObservationConvention, Supplier, ObservationRegistry)
public MicrometerObservationCollectorBuilder defaultProcessObservationConvention(DeliverObservationConvention defaultProcessObservationConvention)
basic.delivery
.
It will be picked if there was neither custom convention nor a pre-configured one via ObservationRegistry
.
Default is DefaultProcessObservationConvention("process")
.
defaultProcessObservationConvention
- the conventionObservationDocumentation.observation(ObservationConvention,
ObservationConvention, Supplier, ObservationRegistry)
public MicrometerObservationCollectorBuilder customReceiveObservationConvention(DeliverObservationConvention customReceiveObservationConvention)
basic.get
.
If not null, it will override any pre-configured conventions.
Default is null
.
customReceiveObservationConvention
- the conventionObservationDocumentation.observation(ObservationConvention,
ObservationConvention, Supplier, ObservationRegistry)
public MicrometerObservationCollectorBuilder defaultReceiveObservationConvention(DeliverObservationConvention defaultReceiveObservationConvention)
basic.get
.
It will be picked if there was neither custom convention nor a pre-configured one via ObservationRegistry
.
Default is DefaultReceiveObservationConvention("receive")
.
defaultReceiveObservationConvention
- the conventionObservationDocumentation.observation(ObservationConvention,
ObservationConvention, Supplier, ObservationRegistry)
public MicrometerObservationCollectorBuilder keepObservationStartedOnBasicGet(boolean keepObservationStartedOnBasicGet)
basic.get
observation started or not.
The MicrometerObservationCollector
starts and stops the observation immediately
after the message reception. This way the observation can have all the context from the
received message but has a very short duration. This is the default behavior.
By setting this flag to true
the collector does not stop the observation and
opens a scope. The processing of the message can then be included in the observation.
This is then the responsibility of the developer to retrieve the observation and stop it to avoid memory leaks. Here is an example:
GetResponse response = channel.basicGet(queue, true); // process the message... // stop the observation Observation.Scope scope = observationRegistry.getCurrentObservationScope(); scope.close(); scope.getCurrentObservation().stop();Default is false, that is stopping the observation immediately.
keepObservationStartedOnBasicGet
- whether to keep the observation started or notpublic ObservationCollector build()
ObservationCollector
.Copyright © 2023 VMware, Inc. or its affiliates.. All rights reserved.