com.neeve.server.mon

Interface ISrvMonIntHistogram

All Superinterfaces:

IRogValidatable

All Known Implementing Classes:

SrvMonIntHistogram

@Generated(value="com.neeve.adm.AdmGenerator",
           date="Thu May 07 15:37:32 EDT 2020")
@AdmGenerated(compatLevel="4.0.0",
              admVersion="nvx-rumi-adm v3.14 (build 29)",
              date="5/7/20 3:37 PM",
              buildInfo="nvx-talon-3.14.19 (nvx-codegen-plugin)")
public interface ISrvMonIntHistogram
extends IRogValidatable

Holds computed histographical data.

SrvMonIntHistogram reports results of XVM side calculations done for SrvMonIntSeries statistics.

ADM Details

ADM Type	Embedded Entity
Factory	SrvMonFactory

ADM Field Summary

Field	Type	Id	Description
maximum	Integer	3	The maximum value recorded in the sample set. The value may not be set if the sample size is 0.
mean	Integer	4	The mean value for the sample set. The value may not be set if the sample size is 0.
median	Integer	5	The median value for the sample set. The value may not be set if the sample size is 0.
minimum	Integer	2	The minimum value recorded in the sample set. The value may not be set if the sample size is 0.
pct75	Integer	6	The 75th percentile for the sample set. The value may not be set if the sample size is 0.
pct90	Integer	7	The 90th percentile for the sample set. The value may not be set if the sample size is 0.
pct99	Integer	8	The 99th percentile for the sample set. The value may not be set if the sample size is 0.
pct999	Integer	9	The 99.9th percentile for the the sample set. The value may not be set if the sample size is 0.
pct9999	Integer	10	The 99.99th percentile for the sample set. The value may not be set if the sample size is 0.
sampleSize	Long	1	The number of datapoints over which results were calculated.
samplesOverMax	Long	11	The number of samples that exceeded the maximum recordable value. When computing data point percentiles using an HDRHistogram it is possible that a recorded value will exceed the maximum value allowable. In this case the data point is downsampled to the maximum recordable value which skews the percentile calculations lower. SamplesOverMax allows detection of how frequently this is occuring.
samplesUnderMin	Long	12	The number of samples that fell below the minimum recordable value. When computing data point percentiles using an HDRHistogram it is possible that a recorded value will be below 0 (e.g for latency stats in cases where clock skew is possible.) In such cases the the value will be upsampled to 0 which can skew the histogram results. SamplesUnderMin allows detection of how frequently this is happening.

Method Summary

Methods

Modifier and Type	Method and Description
void	clearMaximum() Clears the value of 'maximum'.
void	clearMean() Clears the value of 'mean'.
void	clearMedian() Clears the value of 'median'.
void	clearMinimum() Clears the value of 'minimum'.
void	clearPct75() Clears the value of 'pct75'.
void	clearPct90() Clears the value of 'pct90'.
void	clearPct99() Clears the value of 'pct99'.
void	clearPct999() Clears the value of 'pct999'.
void	clearPct9999() Clears the value of 'pct9999'.
void	clearSampleSize() Clears the value of 'sampleSize'.
void	clearSamplesOverMax() Clears the value of 'samplesOverMax'.
void	clearSamplesUnderMin() Clears the value of 'samplesUnderMin'.
int	getMaximum() Gets the value of 'maximum'.
int	getMean() Gets the value of 'mean'.
int	getMedian() Gets the value of 'median'.
int	getMinimum() Gets the value of 'minimum'.
int	getPct75() Gets the value of 'pct75'.
int	getPct90() Gets the value of 'pct90'.
int	getPct99() Gets the value of 'pct99'.
int	getPct999() Gets the value of 'pct999'.
int	getPct9999() Gets the value of 'pct9999'.
long	getSampleSize() Gets the value of 'sampleSize'.
long	getSamplesOverMax() Gets the value of 'samplesOverMax'.
long	getSamplesUnderMin() Gets the value of 'samplesUnderMin'.
boolean	hasMaximum() Checks for the presence of 'maximum'.
boolean	hasMean() Checks for the presence of 'mean'.
boolean	hasMedian() Checks for the presence of 'median'.
boolean	hasMinimum() Checks for the presence of 'minimum'.
boolean	hasPct75() Checks for the presence of 'pct75'.
boolean	hasPct90() Checks for the presence of 'pct90'.
boolean	hasPct99() Checks for the presence of 'pct99'.
boolean	hasPct999() Checks for the presence of 'pct999'.
boolean	hasPct9999() Checks for the presence of 'pct9999'.
boolean	hasSampleSize() Checks for the presence of 'sampleSize'.
boolean	hasSamplesOverMax() Checks for the presence of 'samplesOverMax'.
boolean	hasSamplesUnderMin() Checks for the presence of 'samplesUnderMin'.
void	setMaximum(int val) Sets the value of 'maximum'.
void	setMean(int val) Sets the value of 'mean'.
void	setMedian(int val) Sets the value of 'median'.
void	setMinimum(int val) Sets the value of 'minimum'.
void	setPct75(int val) Sets the value of 'pct75'.
void	setPct90(int val) Sets the value of 'pct90'.
void	setPct99(int val) Sets the value of 'pct99'.
void	setPct999(int val) Sets the value of 'pct999'.
void	setPct9999(int val) Sets the value of 'pct9999'.
void	setSampleSize(long val) Sets the value of 'sampleSize'.
void	setSamplesOverMax(long val) Sets the value of 'samplesOverMax'.
void	setSamplesUnderMin(long val) Sets the value of 'samplesUnderMin'.

Methods inherited from interface com.neeve.rog.IRogValidatable

getValidationErrors, isValid

Method Detail

setSampleSize

void setSampleSize(long val)

Sets the value of 'sampleSize'.

Field Description

The number of datapoints over which results were calculated.

Parameters:

val - The value to set.

getSampleSize

long getSampleSize()

Gets the value of 'sampleSize'.

Field Description

The number of datapoints over which results were calculated.

Returns:

The number of datapoints over which results were calculated.

clearSampleSize

void clearSampleSize()

Clears the value of 'sampleSize'.

Field Description

The number of datapoints over which results were calculated.

See Also:

setSampleSize(long)

hasSampleSize

boolean hasSampleSize()

Checks for the presence of 'sampleSize'.

Field Description

The number of datapoints over which results were calculated.

See Also:

getSampleSize()

setMinimum

void setMinimum(int val)

Sets the value of 'minimum'.

Field Description

The minimum value recorded in the sample set.

The value may not be set if the sample size is 0.

Parameters:

val - The value to set.

getMinimum

int getMinimum()

Gets the value of 'minimum'.

Field Description

The minimum value recorded in the sample set.

The value may not be set if the sample size is 0.

Returns:

The minimum value recorded in the sample set.

clearMinimum

void clearMinimum()

Clears the value of 'minimum'.

Field Description

The minimum value recorded in the sample set.

The value may not be set if the sample size is 0.

See Also:

setMinimum(int)

hasMinimum

boolean hasMinimum()

Checks for the presence of 'minimum'.

Field Description

The minimum value recorded in the sample set.

The value may not be set if the sample size is 0.

See Also:

getMinimum()

setMaximum

void setMaximum(int val)

Sets the value of 'maximum'.

Field Description

The maximum value recorded in the sample set.

The value may not be set if the sample size is 0.

Parameters:

val - The value to set.

getMaximum

int getMaximum()

Gets the value of 'maximum'.

Field Description

The maximum value recorded in the sample set.

The value may not be set if the sample size is 0.

Returns:

The maximum value recorded in the sample set.

clearMaximum

void clearMaximum()

Clears the value of 'maximum'.

Field Description

The maximum value recorded in the sample set.

The value may not be set if the sample size is 0.

See Also:

setMaximum(int)

hasMaximum

boolean hasMaximum()

Checks for the presence of 'maximum'.

Field Description

The maximum value recorded in the sample set.

The value may not be set if the sample size is 0.

See Also:

getMaximum()

setMean

void setMean(int val)

Sets the value of 'mean'.

Field Description

The mean value for the sample set.

The value may not be set if the sample size is 0.

Parameters:

val - The value to set.

getMean

int getMean()

Gets the value of 'mean'.

Field Description

The mean value for the sample set.

The value may not be set if the sample size is 0.

Returns:

The mean value for the sample set.

clearMean

void clearMean()

Clears the value of 'mean'.

Field Description

The mean value for the sample set.

The value may not be set if the sample size is 0.

See Also:

setMean(int)

hasMean

boolean hasMean()

Checks for the presence of 'mean'.

Field Description

The mean value for the sample set.

The value may not be set if the sample size is 0.

See Also:

getMean()

setMedian

void setMedian(int val)

Sets the value of 'median'.

Field Description

The median value for the sample set.

The value may not be set if the sample size is 0.

Parameters:

val - The value to set.

getMedian

int getMedian()

Gets the value of 'median'.

Field Description

The median value for the sample set.

The value may not be set if the sample size is 0.

Returns:

The median value for the sample set.

clearMedian

void clearMedian()

Clears the value of 'median'.

Field Description

The median value for the sample set.

The value may not be set if the sample size is 0.

See Also:

setMedian(int)

hasMedian

boolean hasMedian()

Checks for the presence of 'median'.

Field Description

The median value for the sample set.

The value may not be set if the sample size is 0.

See Also:

getMedian()

setPct75

void setPct75(int val)

Sets the value of 'pct75'.

Field Description

The 75th percentile for the sample set.

The value may not be set if the sample size is 0.

Parameters:

val - The value to set.

getPct75

int getPct75()

Gets the value of 'pct75'.

Field Description

The 75th percentile for the sample set.

The value may not be set if the sample size is 0.

Returns:

The 75th percentile for the sample set.

clearPct75

void clearPct75()

Clears the value of 'pct75'.

Field Description

The 75th percentile for the sample set.

The value may not be set if the sample size is 0.

See Also:

setPct75(int)

hasPct75

boolean hasPct75()

Checks for the presence of 'pct75'.

Field Description

The 75th percentile for the sample set.

The value may not be set if the sample size is 0.

See Also:

getPct75()

setPct90

void setPct90(int val)

Sets the value of 'pct90'.

Field Description

The 90th percentile for the sample set.

The value may not be set if the sample size is 0.

Parameters:

val - The value to set.

getPct90

int getPct90()

Gets the value of 'pct90'.

Field Description

The 90th percentile for the sample set.

The value may not be set if the sample size is 0.

Returns:

The 90th percentile for the sample set.

clearPct90

void clearPct90()

Clears the value of 'pct90'.

Field Description

The 90th percentile for the sample set.

The value may not be set if the sample size is 0.

See Also:

setPct90(int)

hasPct90

boolean hasPct90()

Checks for the presence of 'pct90'.

Field Description

The 90th percentile for the sample set.

The value may not be set if the sample size is 0.

See Also:

getPct90()

setPct99

void setPct99(int val)

Sets the value of 'pct99'.

Field Description

The 99th percentile for the sample set.

The value may not be set if the sample size is 0.

Parameters:

val - The value to set.

getPct99

int getPct99()

Gets the value of 'pct99'.

Field Description

The 99th percentile for the sample set.

The value may not be set if the sample size is 0.

Returns:

The 99th percentile for the sample set.

clearPct99

void clearPct99()

Clears the value of 'pct99'.

Field Description

The 99th percentile for the sample set.

The value may not be set if the sample size is 0.

See Also:

setPct99(int)

hasPct99

boolean hasPct99()

Checks for the presence of 'pct99'.

Field Description

The 99th percentile for the sample set.

The value may not be set if the sample size is 0.

See Also:

getPct99()

setPct999

void setPct999(int val)

Sets the value of 'pct999'.

Field Description

The 99.9th percentile for the the sample set.

The value may not be set if the sample size is 0.

Parameters:

val - The value to set.

getPct999

int getPct999()

Gets the value of 'pct999'.

Field Description

The 99.9th percentile for the the sample set.

The value may not be set if the sample size is 0.

Returns:

The 99.9th percentile for the the sample set.

clearPct999

void clearPct999()

Clears the value of 'pct999'.

Field Description

The 99.9th percentile for the the sample set.

The value may not be set if the sample size is 0.

See Also:

setPct999(int)

hasPct999

boolean hasPct999()

Checks for the presence of 'pct999'.

Field Description

The 99.9th percentile for the the sample set.

The value may not be set if the sample size is 0.

See Also:

getPct999()

setPct9999

void setPct9999(int val)

Sets the value of 'pct9999'.

Field Description

The 99.99th percentile for the sample set.

The value may not be set if the sample size is 0.

Parameters:

val - The value to set.

getPct9999

int getPct9999()

Gets the value of 'pct9999'.

Field Description

The 99.99th percentile for the sample set.

The value may not be set if the sample size is 0.

Returns:

The 99.99th percentile for the sample set.

clearPct9999

void clearPct9999()

Clears the value of 'pct9999'.

Field Description

The 99.99th percentile for the sample set.

The value may not be set if the sample size is 0.

See Also:

setPct9999(int)

hasPct9999

boolean hasPct9999()

Checks for the presence of 'pct9999'.

Field Description

The 99.99th percentile for the sample set.

The value may not be set if the sample size is 0.

See Also:

getPct9999()

setSamplesOverMax

void setSamplesOverMax(long val)

Sets the value of 'samplesOverMax'.

Field Description

The number of samples that exceeded the maximum recordable value.

When computing data point percentiles using an HDRHistogram it is possible that a recorded value will exceed the maximum value allowable. In this case the data point is downsampled to the maximum recordable value which skews the percentile calculations lower. SamplesOverMax allows detection of how frequently this is occuring.

Parameters:

val - The value to set.

getSamplesOverMax

long getSamplesOverMax()

Gets the value of 'samplesOverMax'.

Field Description

The number of samples that exceeded the maximum recordable value.

When computing data point percentiles using an HDRHistogram it is possible that a recorded value will exceed the maximum value allowable. In this case the data point is downsampled to the maximum recordable value which skews the percentile calculations lower. SamplesOverMax allows detection of how frequently this is occuring.

Returns:

The number of samples that exceeded the maximum recordable value.

clearSamplesOverMax

void clearSamplesOverMax()

Clears the value of 'samplesOverMax'.

Field Description

The number of samples that exceeded the maximum recordable value.

When computing data point percentiles using an HDRHistogram it is possible that a recorded value will exceed the maximum value allowable. In this case the data point is downsampled to the maximum recordable value which skews the percentile calculations lower. SamplesOverMax allows detection of how frequently this is occuring.

See Also:

setSamplesOverMax(long)

hasSamplesOverMax

boolean hasSamplesOverMax()

Checks for the presence of 'samplesOverMax'.

Field Description

The number of samples that exceeded the maximum recordable value.

When computing data point percentiles using an HDRHistogram it is possible that a recorded value will exceed the maximum value allowable. In this case the data point is downsampled to the maximum recordable value which skews the percentile calculations lower. SamplesOverMax allows detection of how frequently this is occuring.

See Also:

getSamplesOverMax()

setSamplesUnderMin

void setSamplesUnderMin(long val)

Sets the value of 'samplesUnderMin'.

Field Description

The number of samples that fell below the minimum recordable value.

When computing data point percentiles using an HDRHistogram it is possible that a recorded value will be below 0 (e.g for latency stats in cases where clock skew is possible.) In such cases the the value will be upsampled to 0 which can skew the histogram results. SamplesUnderMin allows detection of how frequently this is happening.

Parameters:

val - The value to set.

getSamplesUnderMin

long getSamplesUnderMin()

Gets the value of 'samplesUnderMin'.

Field Description

The number of samples that fell below the minimum recordable value.

When computing data point percentiles using an HDRHistogram it is possible that a recorded value will be below 0 (e.g for latency stats in cases where clock skew is possible.) In such cases the the value will be upsampled to 0 which can skew the histogram results. SamplesUnderMin allows detection of how frequently this is happening.

Returns:

The number of samples that fell below the minimum recordable value.

clearSamplesUnderMin

void clearSamplesUnderMin()

Clears the value of 'samplesUnderMin'.

Field Description

The number of samples that fell below the minimum recordable value.

When computing data point percentiles using an HDRHistogram it is possible that a recorded value will be below 0 (e.g for latency stats in cases where clock skew is possible.) In such cases the the value will be upsampled to 0 which can skew the histogram results. SamplesUnderMin allows detection of how frequently this is happening.

See Also:

setSamplesUnderMin(long)

hasSamplesUnderMin

boolean hasSamplesUnderMin()

Checks for the presence of 'samplesUnderMin'.

Field Description

The number of samples that fell below the minimum recordable value.

When computing data point percentiles using an HDRHistogram it is possible that a recorded value will be below 0 (e.g for latency stats in cases where clock skew is possible.) In such cases the the value will be upsampled to 0 which can skew the histogram results. SamplesUnderMin allows detection of how frequently this is happening.

See Also:

getSamplesUnderMin()