Top Description Inners Fields Constructors Methods
reactor.core.publisher

pack-priv final Class FluxMetrics<T>

extends InternalFluxOperator<T, T>
Class Inheritance
Annotations
@Deprecated
Imports
java.util.List, java.util.concurrent.TimeUnit, java.util.stream.Collectors, io.micrometer.core.instrument.Clock, io.micrometer.core.instrument.Counter, io.micrometer.core.instrument.DistributionSummary, io.micrometer.core.instrument.MeterRegistry, io.micrometer.core.instrument.Tag, io.micrometer.core.instrument.Tags, io.micrometer.core.instrument.Timer, org.reactivestreams.Publisher, .Subscription, reactor.core.CoreSubscriber, .Scannable, reactor.util.Logger, .Loggers, .Metrics.MicrometerConfiguration

Deprecated

Activate metrics gathering on a Flux, assuming Micrometer is on the classpath.

Implementation Note

Metrics.isInstrumentationAvailable() test should be performed BEFORE instantiating or referencing this class, otherwise a NoClassDefFoundError will be thrown if Micrometer is not there.

Authors
Simon Baslé, Stephane Maldini

Nested and Inner Type Summary

Modifier and TypeClass and Description
pack-priv static class

Field Summary

Modifier and TypeField and Description
pack-priv static final io.micrometer.core.instrument.Tags
DEFAULT_TAGS_FLUX

Tag bearing the sequence's name, as given by the Flux#name(String) operator.

pack-priv static final io.micrometer.core.instrument.Tags
pack-priv static final Logger
pack-priv static final String
METER_FLOW_DURATION

Meter that times the duration elapsed between a subscription and the termination or cancellation of the sequence.

pack-priv static final String
METER_MALFORMED

Meter that counts the number of events received from a malformed source (ie an onNext after an onComplete).

pack-priv static final String
METER_ON_NEXT_DELAY

Meter that times the delays between each onNext (or between the first onNext and the onSubscribe event).

pack-priv static final String
METER_REQUESTED

Meter that tracks the request amount, in named sequences only.

pack-priv static final String
METER_SUBSCRIBED

Meter that counts the number of subscriptions to a sequence.

pack-priv final String
pack-priv static final String
REACTOR_DEFAULT_NAME

The default sequence name that will be used for instrumented Flux and Mono that don't have a name.

pack-priv final io.micrometer.core.instrument.MeterRegistry
pack-priv static final io.micrometer.core.instrument.Tags
pack-priv static final String
TAG_KEY_EXCEPTION

Tag used by METER_FLOW_DURATION when "status" is TAG_ON_ERROR, to store the exception that occurred.

pack-priv static final io.micrometer.core.instrument.Tags
pack-priv static final io.micrometer.core.instrument.Tags
pack-priv static final io.micrometer.core.instrument.Tag
pack-priv final io.micrometer.core.instrument.Tags
Inherited from reactor.core.publisher.InternalFluxOperator:
optimizableOperator

Constructor Summary

AccessConstructor and Description
pack-priv
FluxMetrics(Flux<? extends T> flux)

Method Summary

Modifier and TypeMethod and Description
pack-priv static void
recordCancel(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry, io.micrometer.core.instrument.Timer.Sample flowDuration)

pack-priv static void
recordMalformed(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry)

pack-priv static void
recordOnComplete(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry, io.micrometer.core.instrument.Timer.Sample flowDuration)

pack-priv static void
recordOnCompleteEmpty(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry, io.micrometer.core.instrument.Timer.Sample flowDuration)

pack-priv static void
recordOnError(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry, io.micrometer.core.instrument.Timer.Sample flowDuration, Throwable e)

pack-priv static void
recordOnSubscribe(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry)

pack-priv static String

Returns:

a name
resolveName
(Publisher<?>
the upstream
source
)

Extract the name from the upstream, and detect if there was an actual name (ie.

pack-priv static io.micrometer.core.instrument.Tags

Returns:

a Tags of Tag
resolveTags
(Publisher<?>
the upstream
source
,
io.micrometer.core.instrument.Tags tags)

Extract the tags from the upstream

public Object
scanUnsafe(Scannable.Attr<T>
a Attr to resolve for the component.
key
)

Overrides reactor.core.publisher.InternalFluxOperator.scanUnsafe.

Implements reactor.core.Scannable.scanUnsafe.

This method is used internally by components to define their key-value mappings in a single place.
public CoreSubscriber<? super T>
subscribeOrReturn(CoreSubscriber<? super T> actual)

Implements abstract reactor.core.publisher.InternalFluxOperator.subscribeOrReturn.

Implements reactor.core.publisher.OptimizableOperator.subscribeOrReturn.

Allow delegation of the subscription by returning a CoreSubscriber, or force subscription encapsulation by returning null.
Inherited from reactor.core.publisher.InternalFluxOperator:
nextOptimizableSourcesourcesubscribe

Field Detail

DEFAULT_TAGS_FLUXback to summary
pack-priv static final io.micrometer.core.instrument.Tags DEFAULT_TAGS_FLUX

Tag bearing the sequence's name, as given by the Flux#name(String) operator.

DEFAULT_TAGS_MONOback to summary
pack-priv static final io.micrometer.core.instrument.Tags DEFAULT_TAGS_MONO
logback to summary
pack-priv static final Logger log
METER_FLOW_DURATIONback to summary
pack-priv static final String METER_FLOW_DURATION

Meter that times the duration elapsed between a subscription and the termination or cancellation of the sequence. A status tag is added to specify what event caused the timer to end (completed, completedEmpty, error, cancelled).

METER_MALFORMEDback to summary
pack-priv static final String METER_MALFORMED

Meter that counts the number of events received from a malformed source (ie an onNext after an onComplete).

METER_ON_NEXT_DELAYback to summary
pack-priv static final String METER_ON_NEXT_DELAY

Meter that times the delays between each onNext (or between the first onNext and the onSubscribe event).

METER_REQUESTEDback to summary
pack-priv static final String METER_REQUESTED

Meter that tracks the request amount, in named sequences only.

METER_SUBSCRIBEDback to summary
pack-priv static final String METER_SUBSCRIBED

Meter that counts the number of subscriptions to a sequence.

nameback to summary
pack-priv final String name
REACTOR_DEFAULT_NAMEback to summary
pack-priv static final String REACTOR_DEFAULT_NAME

The default sequence name that will be used for instrumented Flux and Mono that don't have a name.

registryCandidateback to summary
pack-priv final io.micrometer.core.instrument.MeterRegistry registryCandidate
TAG_CANCELback to summary
pack-priv static final io.micrometer.core.instrument.Tags TAG_CANCEL
TAG_KEY_EXCEPTIONback to summary
pack-priv static final String TAG_KEY_EXCEPTION

Tag used by METER_FLOW_DURATION when "status" is TAG_ON_ERROR, to store the exception that occurred.

TAG_ON_COMPLETEback to summary
pack-priv static final io.micrometer.core.instrument.Tags TAG_ON_COMPLETE
TAG_ON_COMPLETE_EMPTYback to summary
pack-priv static final io.micrometer.core.instrument.Tags TAG_ON_COMPLETE_EMPTY
TAG_ON_ERRORback to summary
pack-priv static final io.micrometer.core.instrument.Tag TAG_ON_ERROR
tagsback to summary
pack-priv final io.micrometer.core.instrument.Tags tags

Constructor Detail

FluxMetricsback to summary
pack-priv FluxMetrics(Flux<? extends T> flux)

Method Detail

recordCancelback to summary
pack-priv static void recordCancel(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry, io.micrometer.core.instrument.Timer.Sample flowDuration)
recordMalformedback to summary
pack-priv static void recordMalformed(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry)
recordOnCompleteback to summary
pack-priv static void recordOnComplete(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry, io.micrometer.core.instrument.Timer.Sample flowDuration)
recordOnCompleteEmptyback to summary
pack-priv static void recordOnCompleteEmpty(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry, io.micrometer.core.instrument.Timer.Sample flowDuration)
recordOnErrorback to summary
pack-priv static void recordOnError(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry, io.micrometer.core.instrument.Timer.Sample flowDuration, Throwable e)
recordOnSubscribeback to summary
pack-priv static void recordOnSubscribe(String name, io.micrometer.core.instrument.Tags commonTags, io.micrometer.core.instrument.MeterRegistry registry)
resolveNameback to summary
pack-priv static String resolveName(Publisher<?> source)

Extract the name from the upstream, and detect if there was an actual name (ie. distinct from Scannable#stepName()) set by the user.

Parameters
source:Publisher<?>

the upstream

Returns:String

a name

resolveTagsback to summary
pack-priv static io.micrometer.core.instrument.Tags resolveTags(Publisher<?> source, io.micrometer.core.instrument.Tags tags)

Extract the tags from the upstream

Parameters
source:Publisher<?>

the upstream

Returns:io.micrometer.core.instrument.Tags

a Tags of Tag

scanUnsafeback to summary
public Object scanUnsafe(Scannable.Attr<T> key)

Overrides reactor.core.publisher.InternalFluxOperator.scanUnsafe.

Implements reactor.core.Scannable.scanUnsafe.

Doc from reactor.core.Scannable.scanUnsafe.

This method is used internally by components to define their key-value mappings in a single place. Although it is ignoring the generic type of the Attr key, implementors should take care to return values of the correct type, and return null if no specific value is available.

For public consumption of attributes, prefer using scan(Attr), which will return a typed value and fall back to the key's default if the component didn't define any mapping.

Parameters
key:Scannable.Attr<T>

a Attr to resolve for the component.

Returns:Object

the value associated to the key for that specific component, or null if none.

Annotations
@Override
subscribeOrReturnback to summary
public CoreSubscriber<? super T> subscribeOrReturn(CoreSubscriber<? super T> actual)

Implements abstract reactor.core.publisher.InternalFluxOperator.subscribeOrReturn.

Implements reactor.core.publisher.OptimizableOperator.subscribeOrReturn.

Doc from reactor.core.publisher.OptimizableOperator.subscribeOrReturn.

Allow delegation of the subscription by returning a CoreSubscriber, or force subscription encapsulation by returning null. This can be used in conjunction with nextOptimizableSource() to perform subscription in a loop instead of by recursion.

Returns:CoreSubscriber<? super T>

next CoreSubscriber or "null" if the subscription was already done inside the method

Annotations
@Override
reactor.core.publisher back to summary

pack-priv Class FluxMetrics.MetricsSubscriber<T>

extends Object
implements InnerOperator<T, T>
Class Inheritance
All Implemented Interfaces
reactor.core.publisher.InnerOperator, reactor.core.publisher.InnerProducer, org.reactivestreams.Subscription, reactor.core.Scannable, reactor.core.publisher.InnerConsumer, reactor.core.CoreSubscriber, org.reactivestreams.Subscriber
Known Direct Subclasses
reactor.core.publisher.FluxMetricsFuseable.MetricsFuseableSubscriber

Field Summary

Modifier and TypeField and Description
pack-priv final CoreSubscriber<? super T>
pack-priv final io.micrometer.core.instrument.Clock
pack-priv final io.micrometer.core.instrument.Tags
pack-priv boolean
pack-priv long
pack-priv final io.micrometer.core.instrument.Timer
pack-priv final io.micrometer.core.instrument.MeterRegistry
pack-priv final io.micrometer.core.instrument.DistributionSummary
pack-priv Subscription
s

pack-priv final String
pack-priv io.micrometer.core.instrument.Timer.Sample

Constructor Summary

AccessConstructor and Description
pack-priv
MetricsSubscriber(CoreSubscriber<? super T> actual, io.micrometer.core.instrument.MeterRegistry registry, io.micrometer.core.instrument.Clock clock, String sequenceName, io.micrometer.core.instrument.Tags commonTags)

Method Summary

Modifier and TypeMethod and Description
public final CoreSubscriber<? super T>
public final void
cancel()

Implements org.reactivestreams.Subscription.cancel.

Request the Publisher to stop sending data and clean up resources.
public final void
onComplete()

Implements org.reactivestreams.Subscriber.onComplete.

Successful terminal state.
public final void
onError(Throwable
the throwable signaled
e
)

Implements org.reactivestreams.Subscriber.onError.

Failed terminal state.
public void
onNext(T
the element signaled
t
)

Implements org.reactivestreams.Subscriber.onNext.

Data notification sent by the Publisher in response to requests to Subscription#request(long).
public void
onSubscribe(Subscription
the Subscription that allows requesting data via Subscription#request(long)
s
)

Implements reactor.core.CoreSubscriber.onSubscribe.

Implementors should initialize any state used by onNext(Object) before calling Subscription#request(long).
public final void
request(long
the strictly positive number of elements to requests to the upstream Publisher
l
)

Implements org.reactivestreams.Subscription.request.

No events will be sent by a Publisher until demand is signaled via this method.
public Object
scanUnsafe(Scannable.Attr<T>
a Attr to resolve for the component.
key
)

Overrides default reactor.core.publisher.InnerProducer.scanUnsafe.

Implements reactor.core.Scannable.scanUnsafe.

This method is used internally by components to define their key-value mappings in a single place.
Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

actualback to summary
pack-priv final CoreSubscriber<? super T> actual
clockback to summary
pack-priv final io.micrometer.core.instrument.Clock clock
commonTagsback to summary
pack-priv final io.micrometer.core.instrument.Tags commonTags
doneback to summary
pack-priv boolean done
lastNextEventNanosback to summary
pack-priv long lastNextEventNanos
onNextIntervalTimerback to summary
pack-priv final io.micrometer.core.instrument.Timer onNextIntervalTimer
registryback to summary
pack-priv final io.micrometer.core.instrument.MeterRegistry registry
requestedCounterback to summary
pack-priv final io.micrometer.core.instrument.DistributionSummary requestedCounter
sback to summary
pack-priv Subscription s
sequenceNameback to summary
pack-priv final String sequenceName
subscribeToTerminateSampleback to summary
pack-priv io.micrometer.core.instrument.Timer.Sample subscribeToTerminateSample

Constructor Detail

MetricsSubscriberback to summary
pack-priv MetricsSubscriber(CoreSubscriber<? super T> actual, io.micrometer.core.instrument.MeterRegistry registry, io.micrometer.core.instrument.Clock clock, String sequenceName, io.micrometer.core.instrument.Tags commonTags)

Method Detail

actualback to summary
public final CoreSubscriber<? super T> actual()

Implements reactor.core.publisher.InnerProducer.actual.

Annotations
@Override
cancelback to summary
public final void cancel()

Implements org.reactivestreams.Subscription.cancel.

Doc from org.reactivestreams.Subscription.cancel.

Request the Publisher to stop sending data and clean up resources.

Data may still be sent to meet previously signalled demand after calling cancel.

Annotations
@Override
onCompleteback to summary
public final void onComplete()

Implements org.reactivestreams.Subscriber.onComplete.

Doc from org.reactivestreams.Subscriber.onComplete.

Successful terminal state.

No further events will be sent even if Subscription#request(long) is invoked again.

Annotations
@Override
onErrorback to summary
public final void onError(Throwable e)

Implements org.reactivestreams.Subscriber.onError.

Doc from org.reactivestreams.Subscriber.onError.

Failed terminal state.

No further events will be sent even if Subscription#request(long) is invoked again.

Parameters
e:Throwable

the throwable signaled

Annotations
@Override
onNextback to summary
public void onNext(T t)

Implements org.reactivestreams.Subscriber.onNext.

Doc from org.reactivestreams.Subscriber.onNext.

Data notification sent by the Publisher in response to requests to Subscription#request(long).

Parameters
t:T

the element signaled

Annotations
@Override
onSubscribeback to summary
public void onSubscribe(Subscription s)

Implements reactor.core.CoreSubscriber.onSubscribe.

Doc from reactor.core.CoreSubscriber.onSubscribe.

Implementors should initialize any state used by onNext(Object) before calling Subscription#request(long). Should further onNext related state modification occur, thread-safety will be required.

Note that an invalid request <= 0 will not produce an onError and will simply be ignored or reported through a debug-enabled reactor.util.Logger. Invoked after calling Publisher#subscribe(Subscriber).

No data will start flowing until Subscription#request(long) is invoked.

It is the responsibility of this Subscriber instance to call Subscription#request(long) whenever more data is wanted.

The Publisher will send notifications only in response to Subscription#request(long).

Parameters
s:Subscription

Doc from org.reactivestreams.Subscriber.onSubscribe.

the Subscription that allows requesting data via Subscription#request(long)

Annotations
@Override
requestback to summary
public final void request(long l)

Implements org.reactivestreams.Subscription.request.

Doc from org.reactivestreams.Subscription.request.

No events will be sent by a Publisher until demand is signaled via this method.

It can be called however often and whenever needed—but if the outstanding cumulative demand ever becomes Long.MAX_VALUE or more, it may be treated by the Publisher as "effectively unbounded".

Whatever has been requested can be sent by the Publisher so only signal demand for what can be safely handled.

A Publisher can send less than is requested if the stream ends but then must emit either Subscriber#onError(Throwable) or Subscriber#onComplete().

Parameters
l:long

the strictly positive number of elements to requests to the upstream Publisher

Annotations
@Override
scanUnsafeback to summary
public Object scanUnsafe(Scannable.Attr<T> key)

Overrides default reactor.core.publisher.InnerProducer.scanUnsafe.

Implements reactor.core.Scannable.scanUnsafe.

Doc from reactor.core.Scannable.scanUnsafe.

This method is used internally by components to define their key-value mappings in a single place. Although it is ignoring the generic type of the Attr key, implementors should take care to return values of the correct type, and return null if no specific value is available.

For public consumption of attributes, prefer using scan(Attr), which will return a typed value and fall back to the key's default if the component didn't define any mapping.

Parameters
key:Scannable.Attr<T>

a Attr to resolve for the component.

Returns:Object

the value associated to the key for that specific component, or null if none.

Annotations
@Override