Class AtomicHistogram
- java.lang.Object
-
- org.HdrHistogram.EncodableHistogram
-
- org.HdrHistogram.AbstractHistogramBase
-
- org.HdrHistogram.AbstractHistogram
-
- org.HdrHistogram.Histogram
-
- org.HdrHistogram.AtomicHistogram
-
- All Implemented Interfaces:
java.io.Serializable
,ValueRecorder
- Direct Known Subclasses:
Recorder.InternalAtomicHistogram
public class AtomicHistogram extends Histogram
A High Dynamic Range (HDR) Histogram using atomic
An AtomicHistogram guarantees lossless recording of values into the histogram even when the histogram is updated by multiple threads. It is important to note though that this lossless recording capability is the only thread-safe behavior provided by AtomicHistogram, and that it is not otherwise synchronized. Specifically, AtomicHistogram does not support auto-resizing, does not support value shift operations, and provides no implicit synchronization that would prevent the contents of the histogram from changing during iterations, copies, or addition operations on the histogram. Callers wishing to make potentially concurrent, multi-threaded updates that would safely work in the presence of queries, copies, or additions of histogram objects should either take care to externally synchronize and/or order their access, use thelong
count typeSynchronizedHistogram
variant, or (recommended) use theRecorder
class, which is intended for this purpose.See package description for
org.HdrHistogram
for details.- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.HdrHistogram.AbstractHistogram
AbstractHistogram.AllValues, AbstractHistogram.LinearBucketValues, AbstractHistogram.LogarithmicBucketValues, AbstractHistogram.Percentiles, AbstractHistogram.RecordedValues
-
-
Field Summary
Fields Modifier and Type Field Description (package private) java.util.concurrent.atomic.AtomicLongArray
counts
(package private) long
totalCount
(package private) static java.util.concurrent.atomic.AtomicLongFieldUpdater<AtomicHistogram>
totalCountUpdater
-
Fields inherited from class org.HdrHistogram.Histogram
normalizingIndexOffset
-
Fields inherited from class org.HdrHistogram.AbstractHistogram
leadingZeroCountBase, maxValue, minNonZeroValue, subBucketHalfCount, subBucketHalfCountMagnitude, subBucketMask, unitMagnitude, unitMagnitudeMask
-
Fields inherited from class org.HdrHistogram.AbstractHistogramBase
autoResize, bucketCount, constructionIdentityCount, countsArrayLength, doubleToIntegerValueConversionRatio, endTimeStampMsec, highestTrackableValue, identity, integerToDoubleValueConversionRatio, intermediateUncompressedByteArray, intermediateUncompressedByteBuffer, lowestDiscernibleValue, numberOfSignificantValueDigits, percentileIterator, recordedValuesIterator, startTimeStampMsec, subBucketCount, tag, wordSizeInBytes
-
-
Constructor Summary
Constructors Constructor Description AtomicHistogram(long highestTrackableValue, int numberOfSignificantValueDigits)
Construct a AtomicHistogram given the Highest value to be tracked and a number of significant decimal digits.AtomicHistogram(long lowestDiscernibleValue, long highestTrackableValue, int numberOfSignificantValueDigits)
Construct a AtomicHistogram given the Lowest and Highest values to be tracked and a number of significant decimal digits.AtomicHistogram(AbstractHistogram source)
Construct a histogram with the same range settings as a given source histogram, duplicating the source's start/end timestamps (but NOT it's contents)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description (package private) int
_getEstimatedFootprintInBytes()
(package private) void
addToCountAtIndex(int index, long value)
(package private) void
addToTotalCount(long value)
(package private) void
clearCounts()
AtomicHistogram
copy()
Create a copy of this histogram, complete with data and everything.AtomicHistogram
copyCorrectedForCoordinatedOmission(long expectedIntervalBetweenValueSamples)
Get a copy of this histogram, corrected for coordinated omission.static AtomicHistogram
decodeFromByteBuffer(java.nio.ByteBuffer buffer, long minBarForHighestTrackableValue)
Construct a new histogram by decoding it from a ByteBuffer.static AtomicHistogram
decodeFromCompressedByteBuffer(java.nio.ByteBuffer buffer, long minBarForHighestTrackableValue)
Construct a new histogram by decoding it from a compressed form in a ByteBuffer.static AtomicHistogram
fromString(java.lang.String base64CompressedHistogramString)
Construct a new AtomicHistogram by decoding it from a String containing a base64 encoded compressed histogram representation.(package private) long
getCountAtIndex(int index)
(package private) long
getCountAtNormalizedIndex(int index)
(package private) int
getNormalizingIndexOffset()
long
getTotalCount()
Get the total count of all recorded values in the histogram(package private) void
incrementCountAtIndex(int index)
(package private) void
incrementTotalCount()
private void
readObject(java.io.ObjectInputStream o)
(package private) void
resize(long newHighestTrackableValue)
void
setAutoResize(boolean autoResize)
Control whether or not the histogram can auto-resize and auto-adjust it's highestTrackableValue(package private) void
setCountAtIndex(int index, long value)
(package private) void
setCountAtNormalizedIndex(int index, long value)
(package private) void
setNormalizingIndexOffset(int normalizingIndexOffset)
(package private) void
setTotalCount(long totalCount)
(package private) void
shiftNormalizingIndexByOffset(int offsetToAdd, boolean lowestHalfBucketPopulated, double newIntegerToDoubleValueConversionRatio)
boolean
supportsAutoResize()
Indicate whether or not the histogram is capable of supporting auto-resize functionality.-
Methods inherited from class org.HdrHistogram.Histogram
setIntegerToDoubleValueConversionRatio
-
Methods inherited from class org.HdrHistogram.AbstractHistogram
add, addWhileCorrectingForCoordinatedOmission, allValues, copyInto, copyIntoCorrectedForCoordinatedOmission, countsArrayIndex, decodeFromByteBuffer, decodeFromCompressedByteBuffer, determineArrayLengthNeeded, encodeIntoByteBuffer, encodeIntoCompressedByteBuffer, encodeIntoCompressedByteBuffer, equals, establishInternalTackingValues, establishInternalTackingValues, establishSize, fillBufferFromCountsArray, getBucketIndex, getBucketsNeededToCoverValue, getCountAtValue, getCountBetweenValues, getEndTimeStamp, getEstimatedFootprintInBytes, getHighestTrackableValue, getLengthForNumberOfBuckets, getLowestDiscernibleValue, getMaxValue, getMaxValueAsDouble, getMean, getMinNonZeroValue, getMinValue, getNeededByteBufferCapacity, getNeededByteBufferCapacity, getNeededPayloadByteBufferCapacity, getNeededV0PayloadByteBufferCapacity, getNumberOfSignificantValueDigits, getPercentileAtOrBelowValue, getStartTimeStamp, getStdDeviation, getSubBucketIndex, getTag, getValueAtPercentile, hashCode, highestEquivalentValue, isAutoResize, linearBucketValues, logarithmicBucketValues, lowestEquivalentValue, medianEquivalentValue, nextNonEquivalentValue, nonConcurrentNormalizingIndexShift, normalizeIndex, numberOfSubbuckets, outputPercentileDistribution, outputPercentileDistribution, outputPercentileDistribution, percentiles, recordConvertedDoubleValue, recordConvertedDoubleValueWithCount, recordedValues, recordValue, recordValue, recordValueWithCount, recordValueWithExpectedInterval, reset, setEndTimeStamp, setStartTimeStamp, setTag, shiftValuesLeft, shiftValuesLeft, shiftValuesRight, shiftValuesRight, sizeOfEquivalentValueRange, subtract, toString, updateMinAndMax, valueFromIndex, valuesAreEquivalent
-
Methods inherited from class org.HdrHistogram.AbstractHistogramBase
getDoubleToIntegerValueConversionRatio, getIntegerToDoubleValueConversionRatio, nonConcurrentSetIntegerToDoubleValueConversionRatio
-
-
-
-
Field Detail
-
totalCountUpdater
static final java.util.concurrent.atomic.AtomicLongFieldUpdater<AtomicHistogram> totalCountUpdater
-
totalCount
volatile long totalCount
-
counts
volatile java.util.concurrent.atomic.AtomicLongArray counts
-
-
Constructor Detail
-
AtomicHistogram
public AtomicHistogram(long highestTrackableValue, int numberOfSignificantValueDigits)
Construct a AtomicHistogram given the Highest value to be tracked and a number of significant decimal digits. The histogram will be constructed to implicitly track (distinguish from 0) values as low as 1.- Parameters:
highestTrackableValue
- The highest value to be tracked by the histogram. Must be a positive integer that is >= 2.numberOfSignificantValueDigits
- Specifies the precision to use. This is the number of significant decimal digits to which the histogram will maintain value resolution and separation. Must be a non-negative integer between 0 and 5.
-
AtomicHistogram
public AtomicHistogram(long lowestDiscernibleValue, long highestTrackableValue, int numberOfSignificantValueDigits)
Construct a AtomicHistogram given the Lowest and Highest values to be tracked and a number of significant decimal digits. Providing a lowestDiscernibleValue is useful is situations where the units used for the histogram's values are much smaller that the minimal accuracy required. E.g. when tracking time values stated in nanosecond units, where the minimal accuracy required is a microsecond, the proper value for lowestDiscernibleValue would be 1000.- Parameters:
lowestDiscernibleValue
- The lowest value that can be tracked (distinguished from 0) by the histogram. Must be a positive integer that is >= 1. May be internally rounded down to nearest power of 2.highestTrackableValue
- The highest value to be tracked by the histogram. Must be a positive integer that is >= (2 * lowestDiscernibleValue).numberOfSignificantValueDigits
- Specifies the precision to use. This is the number of significant decimal digits to which the histogram will maintain value resolution and separation. Must be a non-negative integer between 0 and 5.
-
AtomicHistogram
public AtomicHistogram(AbstractHistogram source)
Construct a histogram with the same range settings as a given source histogram, duplicating the source's start/end timestamps (but NOT it's contents)- Parameters:
source
- The source histogram to duplicate
-
-
Method Detail
-
getCountAtIndex
long getCountAtIndex(int index)
- Overrides:
getCountAtIndex
in classHistogram
-
getCountAtNormalizedIndex
long getCountAtNormalizedIndex(int index)
- Overrides:
getCountAtNormalizedIndex
in classHistogram
-
incrementCountAtIndex
void incrementCountAtIndex(int index)
- Overrides:
incrementCountAtIndex
in classHistogram
-
addToCountAtIndex
void addToCountAtIndex(int index, long value)
- Overrides:
addToCountAtIndex
in classHistogram
-
setCountAtIndex
void setCountAtIndex(int index, long value)
- Overrides:
setCountAtIndex
in classHistogram
-
setCountAtNormalizedIndex
void setCountAtNormalizedIndex(int index, long value)
- Overrides:
setCountAtNormalizedIndex
in classHistogram
-
getNormalizingIndexOffset
int getNormalizingIndexOffset()
- Overrides:
getNormalizingIndexOffset
in classHistogram
-
setNormalizingIndexOffset
void setNormalizingIndexOffset(int normalizingIndexOffset)
- Overrides:
setNormalizingIndexOffset
in classHistogram
-
shiftNormalizingIndexByOffset
void shiftNormalizingIndexByOffset(int offsetToAdd, boolean lowestHalfBucketPopulated, double newIntegerToDoubleValueConversionRatio)
- Overrides:
shiftNormalizingIndexByOffset
in classHistogram
-
setAutoResize
public void setAutoResize(boolean autoResize)
Description copied from class:AbstractHistogram
Control whether or not the histogram can auto-resize and auto-adjust it's highestTrackableValue- Overrides:
setAutoResize
in classAbstractHistogram
- Parameters:
autoResize
- autoResize setting
-
supportsAutoResize
public boolean supportsAutoResize()
Description copied from class:AbstractHistogram
Indicate whether or not the histogram is capable of supporting auto-resize functionality. Note that this is an indication that enabling auto-resize by calling setAutoResize() is allowed, and NOT that the histogram will actually auto-resize. Use isAutoResize() to determine if the histogram is in auto-resize mode.- Overrides:
supportsAutoResize
in classAbstractHistogram
- Returns:
- autoResize setting
-
clearCounts
void clearCounts()
- Overrides:
clearCounts
in classHistogram
-
copy
public AtomicHistogram copy()
Description copied from class:AbstractHistogram
Create a copy of this histogram, complete with data and everything.
-
copyCorrectedForCoordinatedOmission
public AtomicHistogram copyCorrectedForCoordinatedOmission(long expectedIntervalBetweenValueSamples)
Description copied from class:AbstractHistogram
Get a copy of this histogram, corrected for coordinated omission.To compensate for the loss of sampled values when a recorded value is larger than the expected interval between value samples, the new histogram will include an auto-generated additional series of decreasingly-smaller (down to the expectedIntervalBetweenValueSamples) value records for each count found in the current histogram that is larger than the expectedIntervalBetweenValueSamples. Note: This is a post-correction method, as opposed to the at-recording correction method provided by
recordValueWithExpectedInterval
. The two methods are mutually exclusive, and only one of the two should be be used on a given data set to correct for the same coordinated omission issue. bySee notes in the description of the Histogram calls for an illustration of why this corrective behavior is important.
- Overrides:
copyCorrectedForCoordinatedOmission
in classHistogram
- Parameters:
expectedIntervalBetweenValueSamples
- If expectedIntervalBetweenValueSamples is larger than 0, add auto-generated value records as appropriate if value is larger than expectedIntervalBetweenValueSamples- Returns:
- a copy of this histogram, corrected for coordinated omission.
-
getTotalCount
public long getTotalCount()
Description copied from class:AbstractHistogram
Get the total count of all recorded values in the histogram- Overrides:
getTotalCount
in classHistogram
- Returns:
- the total count of all recorded values in the histogram
-
setTotalCount
void setTotalCount(long totalCount)
- Overrides:
setTotalCount
in classHistogram
-
incrementTotalCount
void incrementTotalCount()
- Overrides:
incrementTotalCount
in classHistogram
-
addToTotalCount
void addToTotalCount(long value)
- Overrides:
addToTotalCount
in classHistogram
-
_getEstimatedFootprintInBytes
int _getEstimatedFootprintInBytes()
- Overrides:
_getEstimatedFootprintInBytes
in classHistogram
-
decodeFromByteBuffer
public static AtomicHistogram decodeFromByteBuffer(java.nio.ByteBuffer buffer, long minBarForHighestTrackableValue)
Construct a new histogram by decoding it from a ByteBuffer.- Parameters:
buffer
- The buffer to decode fromminBarForHighestTrackableValue
- Force highestTrackableValue to be set at least this high- Returns:
- The newly constructed histogram
-
decodeFromCompressedByteBuffer
public static AtomicHistogram decodeFromCompressedByteBuffer(java.nio.ByteBuffer buffer, long minBarForHighestTrackableValue) throws java.util.zip.DataFormatException
Construct a new histogram by decoding it from a compressed form in a ByteBuffer.- Parameters:
buffer
- The buffer to decode fromminBarForHighestTrackableValue
- Force highestTrackableValue to be set at least this high- Returns:
- The newly constructed histogram
- Throws:
java.util.zip.DataFormatException
- on error parsing/decompressing the buffer
-
fromString
public static AtomicHistogram fromString(java.lang.String base64CompressedHistogramString) throws java.util.zip.DataFormatException
Construct a new AtomicHistogram by decoding it from a String containing a base64 encoded compressed histogram representation.- Parameters:
base64CompressedHistogramString
- A string containing a base64 encoding of a compressed histogram- Returns:
- A AtomicHistogram decoded from the string
- Throws:
java.util.zip.DataFormatException
- on error parsing/decompressing the input
-
readObject
private void readObject(java.io.ObjectInputStream o) throws java.io.IOException, java.lang.ClassNotFoundException
- Throws:
java.io.IOException
java.lang.ClassNotFoundException
-
-