org.apache.beam.sdk.util

Class HistogramData

java.lang.Object

org.apache.beam.sdk.util.HistogramData

All Implemented Interfaces:

java.io.Serializable

@Experimental
public class HistogramData
extends java.lang.Object
implements java.io.Serializable

A histogram that supports estimated percentile with linear interpolation.

We may consider using Apache Commons or HdrHistogram library in the future for advanced features such as sparsely populated histograms.

This class is considered experimental and may break or receive backwards-incompatible changes in future versions of the Apache Beam SDK.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HistogramData.BucketType
static class	HistogramData.LinearBuckets

Constructor Summary

Constructors

Constructor and Description
HistogramData(HistogramData.BucketType bucketType) Create a histogram.

Method Summary

Modifier and Type	Method and Description
void	clear()
long	getBottomBucketCount()
HistogramData.BucketType	getBucketType()
long	getCount(int bucketIndex) TODO(BEAM-12103): Update this function to allow indexing the -INF and INF bucket (using 0 and length -1) Get the bucket count for the given bucketIndex.
java.lang.String	getPercentileString(java.lang.String elemType, java.lang.String unit)
long	getTopBucketCount()
long	getTotalCount()
void	incBottomBucketCount(long count)
void	incBucketCount(int bucketIndex, long count)
void	incTopBucketCount(long count)
static HistogramData	linear(double start, double width, int numBuckets) TODO(BEAM-12103): Update this function to define numBuckets total, including the infinite buckets.
double	p50()
double	p90()
double	p99()
void	record(double... values)
void	record(double value)
void	update(HistogramData other)

Methods inherited from class java.lang.Object

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

Constructor Detail

HistogramData

public HistogramData(HistogramData.BucketType bucketType)

Create a histogram.

Parameters:

bucketType - a bucket type for a new histogram instance.

Method Detail

getBucketType

public HistogramData.BucketType getBucketType()

linear

public static HistogramData linear(double start,
                                   double width,
                                   int numBuckets)

TODO(BEAM-12103): Update this function to define numBuckets total, including the infinite buckets. Create a histogram with linear buckets.

Parameters:

start - Lower bound of a starting bucket.

width - Bucket width. Smaller width implies a better resolution for percentile estimation.

numBuckets - The number of buckets. Upper bound of an ending bucket is defined by start + width * numBuckets.

Returns:

a new Histogram instance.

record

public void record(double... values)

update

public void update(HistogramData other)

incBucketCount

public void incBucketCount(int bucketIndex,
                           long count)

incTopBucketCount

public void incTopBucketCount(long count)

incBottomBucketCount

public void incBottomBucketCount(long count)

clear

public void clear()

record

public void record(double value)

getTotalCount

public long getTotalCount()

getPercentileString

public java.lang.String getPercentileString(java.lang.String elemType,
                                            java.lang.String unit)

getCount

public long getCount(int bucketIndex)

TODO(BEAM-12103): Update this function to allow indexing the -INF and INF bucket (using 0 and length -1) Get the bucket count for the given bucketIndex.

This method does not guarantee the atomicity when sequentially accessing the multiple buckets i.e. other threads may alter the value between consecutive invocations. For summing the total number of elements in the histogram, use `getTotalCount()` instead.

Parameters:

bucketIndex - index of the bucket

Returns:

The number of elements in the specified bucket

getTopBucketCount

public long getTopBucketCount()

getBottomBucketCount

public long getBottomBucketCount()

p99

public double p99()

p90

public double p90()

p50

public double p50()