Skip to content

Commit c15ce23

Browse files
authored
docs: Update classicBuckets() to classicUpperBounds() (#1644)
Commit c57e49c (2023-09-23, "Rename buckets to upperBounds in histogram builder") renamed method `classicBuckets()` to `classicUpperBounds()` but missed renames in `docs/` and in one javadoc link. Fix the documentation to the new name. Signed-off-by: Dov Murik <[email protected]>
1 parent 446a097 commit c15ce23

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

docs/content/getting-started/metric-types.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -109,9 +109,9 @@ most cases you don't need them, defaults are good. The following is an incomplet
109109
most important options:
110110

111111
- `nativeOnly()` / `classicOnly()`: Create a histogram with one representation only.
112-
- `classicBuckets(...)`: Set the classic bucket boundaries. Default buckets are `.005`, `.01`,
113-
`.025`, `.05`, `.1`, `.25`, `.5`, `1`, `2.5`, `5`, `and 10`. The default bucket boundaries are
114-
designed for measuring request durations in seconds.
112+
- `classicUpperBounds(...)`: Set the classic bucket upper boundaries. Default bucket upper
113+
boundaries are `.005`, `.01`, `.025`, `.05`, `.1`, `.25`, `.5`, `1`, `2.5`, `5`, `and 10`. The
114+
default bucket boundaries are designed for measuring request durations in seconds.
115115
- `nativeMaxNumberOfBuckets()`: Upper limit for the number of native histogram buckets.
116116
Default is 160. When the maximum is reached, the native histogram automatically
117117
reduces resolution to stay below the limit.

prometheus-metrics-config/src/main/java/io/prometheus/metrics/config/MetricsProperties.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ public Boolean getHistogramClassicOnly() {
263263
return histogramClassicOnly;
264264
}
265265

266-
/** See {@code Histogram.Builder.classicBuckets()} */
266+
/** See {@code Histogram.Builder.classicUpperBounds()} */
267267
@Nullable
268268
public List<Double> getHistogramClassicUpperBounds() {
269269
return histogramClassicUpperBounds;

0 commit comments

Comments
 (0)