Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix javadoc in Aggregations class #886

Merged
merged 1 commit into from
Feb 19, 2020
Merged

Fix javadoc in Aggregations class #886

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 11 additions & 7 deletions sdk/src/main/java/io/opentelemetry/sdk/metrics/view/Aggregations.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,41 +28,45 @@
public class Aggregations {

/**
* Aggregation that calculates sum of recorded measurements.
* Returns an {@code Aggregation} that calculates sum of recorded measurements.
*
* @return an {@code Aggregation} that calculates sum of recorded measurements.
* @since 0.1.0
*/
public static Aggregation sum() {
return Sum.INSTANCE;
}

/**
* Aggregation that calculates count of recorded measurements (the number of recorded
* measurements).
* Returns an {@code Aggregation} that calculates count of recorded measurements (the number of
* recorded measurements).
*
* @return an {@code Aggregation} that calculates count of recorded measurements (the number of
* recorded * measurements).
* @since 0.1.0
*/
public static Aggregation count() {
return Count.INSTANCE;
}

/**
* Aggregation that calculates distribution stats on recorded measurements. Distribution includes
* sum, count, histogram, and sum of squared deviations.
* Returns an {@code Aggregation} that calculates distribution stats on recorded measurements.
* Distribution includes sum, count, histogram, and sum of squared deviations.
*
* <p>The boundaries for the buckets in the underlying histogram needs to be sorted.
*
* @param bucketBoundaries bucket boundaries to use for distribution.
* @return a new {@code Distribution}.
* @return an {@code Aggregation} that calculates distribution stats on recorded measurements.
* @since 0.1.0
*/
public static Aggregation distributionWithExplicitBounds(Double... bucketBoundaries) {
return new Distribution(bucketBoundaries);
}

/**
* Aggregation that calculates the last value of all recorded measurements.
* Returns an {@code Aggregation} that calculates the last value of all recorded measurements.
*
* @return an {@code Aggregation} that calculates the last value of all recorded measurements.
* @since 0.1.0
*/
public static Aggregation lastValue() {
Expand Down