Uses of Class
org.forgerock.monitoring.api.lang.Nullable

Packages that use Nullable

Package	Description
org.forgerock.monitoring.api.instrument	Common Monitoring API Core based on MicroMeter
org.forgerock.monitoring.api.instrument.config	Common Monitoring API Config functionality based on MicroMeter
org.forgerock.monitoring.api.instrument.histogram	Common Monitoring API Histogram based on MicroMeter
org.forgerock.monitoring.api.instrument.search	Common Monitoring API Search functionality based on MicroMeter
org.forgerock.monitoring.dropwizard	Implementation for Common Monitoring API based on DropWizard.

Uses of Nullable in org.forgerock.monitoring.api.instrument

Methods in org.forgerock.monitoring.api.instrument with annotations of type Nullable

Modifier and Type	Method and Description
static <T> Gauge.Builder<T>	Gauge.doubleGauge(String name, DoubleSupplier valueFunction) Setup a Gauge.Builder that will create a gauge that reports the size of the Map.
static <T extends Collection<?>> Gauge.Builder<T>	Gauge.gaugeCollectionSize(String name, T collection) Setup a Gauge.Builder that will create a gauge that reports the size of the Collection.
static <T extends Map<?,?>> Gauge.Builder	Gauge.gaugeMapSize(String name, T map) Setup a Gauge.Builder that will create a gauge that reports the size of the Map.
String	Meter.Id.getBaseUnit()
String	Meter.Id.getDescription()
String	Meter.Id.getTag(String key)

Method parameters in org.forgerock.monitoring.api.instrument with annotations of type Nullable

Modifier and Type	Method and Description
Tags	Tags.and(Iterable<? extends Tag> tags) Return a new Tags instance my merging this collection and the specific tags.
Tags	Tags.and(String... keyValues) Return a new Tags instance my merging this collection and the specific key/value pairs.
Tags	Tags.and(Tag... tags) Return a new Tags instance my merging this collection and the specific tags.
Meter.Builder	Meter.Builder.baseUnit(String unit)
Gauge.Builder<T>	Gauge.Builder.baseUnit(String unit)
DistributionSummary.Builder	DistributionSummary.Builder.baseUnit(String unit)
Counter.Builder	Counter.Builder.baseUnit(String unit) Associate a BaseUnit with the Counter
static <T> Gauge.Builder<T>	Gauge.builder(String name, T obj, ToDoubleFunction<T> f) Setup a Gauge.Builder that will create a gauge that reports the value returned by the provided function.
Timer.Builder	Timer.Builder.description(String description)
TimeGauge.Builder<T>	TimeGauge.Builder.description(String description)
Meter.Builder	Meter.Builder.description(String description)
Gauge.Builder<T>	Gauge.Builder.description(String description)
DistributionSummary.Builder	DistributionSummary.Builder.description(String description)
Counter.Builder	Counter.Builder.description(String description) Associate a description with the Counter
boolean	Tags.equals(Object obj)
boolean	Meter.Id.equals(Object o)
boolean	ImmutableTag.equals(Object o)
<T> Gauge	MeterRegistry.gauge(Meter.Id id, T obj, ToDoubleFunction<T> valueFunction) Only used by Gauge.builder(String, Object, ToDoubleFunction).
Timer.Builder	Timer.Builder.histogramBufferLength(Integer bufferLength) Statistics emanating from a timer like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets).
DistributionSummary.Builder	DistributionSummary.Builder.histogramBufferLength(Integer bufferLength) Statistics emanating from a distribution summary like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets).
Timer.Builder	Timer.Builder.histogramExpiry(Duration expiry) Statistics emanating from a timer like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets).
DistributionSummary.Builder	DistributionSummary.Builder.histogramExpiry(Duration expiry) Statistics emanating from a distribution summary like max, percentiles, and histogram counts decay over time to give greater weight to recent samples (exception: histogram counts are cumulative for those systems that expect cumulative histogram buckets).
Timer.Builder	Timer.Builder.maximumExpectedValue(Duration max) Sets the maximum value that this timer is expected to observe.
DistributionSummary.Builder	DistributionSummary.Builder.maximumExpectedValue(Long max) Sets the maximum value that this distribution summary is expected to observe.
Timer.Builder	Timer.Builder.minimumExpectedValue(Duration min) Sets the minimum value that this timer is expected to observe.
DistributionSummary.Builder	DistributionSummary.Builder.minimumExpectedValue(Long min) Sets the minimum value that this distribution summary is expected to observe.
static HistogramSnapshot	HistogramSnapshot.of(long count, double total, double max, ValueAtPercentile[] percentileValues, CountAtValue[] histogramCounts)
static HistogramSnapshot	HistogramSnapshot.of(long count, double total, double max, ValueAtPercentile[] percentileValues, CountAtValue[] histogramCounts)
Timer.Builder	Timer.Builder.pauseDetector(PauseDetector pauseDetector) Sets the pause detector implementation to use for this timer.
Timer.Builder	Timer.Builder.publishPercentileHistogram(Boolean enabled) Adds histogram buckets usable for generating aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g.
DistributionSummary.Builder	DistributionSummary.Builder.publishPercentileHistogram(Boolean enabled) Adds histogram buckets usable for generating aggregable percentile approximations in monitoring systems that have query facilities to do so (e.g.
Timer.Builder	Timer.Builder.publishPercentiles(double... percentiles) Produces an additional time series for each requested percentile.
DistributionSummary.Builder	DistributionSummary.Builder.publishPercentiles(double... percentiles) Produces an additional time series for each requested percentile.
Timer.Builder	Timer.Builder.sla(Duration... sla) Publish at a minimum a histogram containing your defined SLA boundaries.
DistributionSummary.Builder	DistributionSummary.Builder.sla(long... sla) Publish at a minimum a histogram containing your defined SLA boundaries.
Meter.Id	Meter.Id.withBaseUnit(String newBaseUnit) Generate a new id with a different base unit.

Constructor parameters in org.forgerock.monitoring.api.instrument with annotations of type Nullable

Constructor and Description
Id(String name, Iterable<Tag> tags, String baseUnit, String description, String hierarchicalName, Meter.Type type)
Id(String name, Iterable<Tag> tags, String baseUnit, String description, String hierarchicalName, Meter.Type type)
Id(String name, Iterable<Tag> tags, String baseUnit, String description, String hierarchicalName, Meter.Type type)

Uses of Nullable in org.forgerock.monitoring.api.instrument.config

Methods in org.forgerock.monitoring.api.instrument.config with annotations of type Nullable

Modifier and Type	Method and Description
default HistogramConfig	MeterFilter.configure(Meter.Id id, HistogramConfig config) This is only called when filtering new timers and distribution summaries (i.e.

Method parameters in org.forgerock.monitoring.api.instrument.config with annotations of type Nullable

Modifier and Type	Method and Description
String	NamingConvention.name(String name, Meter.Type type, String baseUnit)

Uses of Nullable in org.forgerock.monitoring.api.instrument.histogram

Methods in org.forgerock.monitoring.api.instrument.histogram with annotations of type Nullable

Modifier and Type	Method and Description
Integer	HistogramConfig.getHistogramBufferLength()
Duration	HistogramConfig.getHistogramExpiry()
Long	HistogramConfig.getMaximumExpectedValue()
Long	HistogramConfig.getMinimumExpectedValue()
double[]	HistogramConfig.getPercentiles()
long[]	HistogramConfig.getSlaBoundaries()
Boolean	HistogramConfig.isPercentileHistogram()

Method parameters in org.forgerock.monitoring.api.instrument.histogram with annotations of type Nullable

Modifier and Type	Method and Description
HistogramConfig.Builder	HistogramConfig.Builder.histogramBufferLength(Integer bufferLength)
HistogramConfig.Builder	HistogramConfig.Builder.histogramExpiry(Duration expiry)
HistogramConfig.Builder	HistogramConfig.Builder.maximumExpectedValue(Long max)
HistogramConfig.Builder	HistogramConfig.Builder.minimumExpectedValue(Long min)
HistogramConfig.Builder	HistogramConfig.Builder.percentiles(double... percentiles)
HistogramConfig.Builder	HistogramConfig.Builder.percentilesHistogram(Boolean enabled)
HistogramConfig.Builder	HistogramConfig.Builder.sla(long... sla)

Uses of Nullable in org.forgerock.monitoring.api.instrument.search

Methods in org.forgerock.monitoring.api.instrument.search with annotations of type Nullable

Modifier and Type	Method and Description
Counter	Search.counter()
Gauge	Search.gauge()
Meter	Search.meter()
DistributionSummary	Search.summary()
Timer	Search.timer()

Uses of Nullable in org.forgerock.monitoring.dropwizard

Method parameters in org.forgerock.monitoring.dropwizard with annotations of type Nullable

Modifier and Type	Method and Description
<T> Gauge	AbstractMeterRegistry.gauge(Meter.Id id, T obj, ToDoubleFunction<T> valueFunction)
protected abstract <T> Gauge	AbstractMeterRegistry.newGauge(Meter.Id id, T obj, ToDoubleFunction<T> valueFunction) Build a new gauge to be added to the registry.