org.forgerock.monitoring.api.instrument.histogram

Class HistogramConfig

java.lang.Object

org.forgerock.monitoring.api.instrument.histogram.HistogramConfig

All Implemented Interfaces:

org.forgerock.monitoring.api.instrument.internal.Mergeable<HistogramConfig>

public class HistogramConfig
extends Object
implements org.forgerock.monitoring.api.instrument.internal.Mergeable<HistogramConfig>

ForgeRock changes: - Removed @incubating annotation

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	HistogramConfig.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static HistogramConfig	DEFAULT
static HistogramConfig	NONE

Constructor Summary

Constructors

Constructor and Description
HistogramConfig()

Method Summary

Modifier and Type	Method and Description
static HistogramConfig.Builder	builder()
NavigableSet<Long>	getHistogramBuckets(boolean supportsAggregablePercentiles)
Integer	getHistogramBufferLength()
Duration	getHistogramExpiry()
Long	getMaximumExpectedValue()
Long	getMinimumExpectedValue()
double[]	getPercentiles()
long[]	getSlaBoundaries()
Boolean	isPercentileHistogram()
boolean	isPublishingHistogram()
HistogramConfig	merge(HistogramConfig parent) Merge the current value set with that of the supplied object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT

public static final HistogramConfig DEFAULT

NONE

public static final HistogramConfig NONE

Constructor Detail

HistogramConfig

public HistogramConfig()

Method Detail

builder

public static HistogramConfig.Builder builder()

merge

public HistogramConfig merge(HistogramConfig parent)

Description copied from interface: org.forgerock.monitoring.api.instrument.internal.Mergeable

Merge the current value set with that of the supplied object. The supplied object is considered the parent, and values in the callee's value set must override those of the supplied object.

Specified by:

merge in interface org.forgerock.monitoring.api.instrument.internal.Mergeable<HistogramConfig>

Parameters:

parent - the object to merge with

Returns:

the result of the merge operation

isPublishingHistogram

public boolean isPublishingHistogram()

getHistogramBuckets

public NavigableSet<Long> getHistogramBuckets(boolean supportsAggregablePercentiles)

isPercentileHistogram

@Nullable
public Boolean isPercentileHistogram()

getPercentiles

@Nullable
public double[] getPercentiles()

getMinimumExpectedValue

@Nullable
public Long getMinimumExpectedValue()

getMaximumExpectedValue

@Nullable
public Long getMaximumExpectedValue()

getHistogramExpiry

@Nullable
public Duration getHistogramExpiry()

getHistogramBufferLength

@Nullable
public Integer getHistogramBufferLength()

getSlaBoundaries

@Nullable
public long[] getSlaBoundaries()