Clarify complete expiry of distribution statistics in Javadoc (#4581)

See gh-2751
micrometer-metrics · Jan 17, 2024 · 6f61874 · 6f61874
1 parent c790b47
commit 6f61874
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 3 deletions.
diff --git a/micrometer-core/src/main/java/io/micrometer/core/instrument/AbstractTimerBuilder.java b/micrometer-core/src/main/java/io/micrometer/core/instrument/AbstractTimerBuilder.java
@@ -199,7 +199,8 @@ public B maximumExpectedValue(@Nullable Duration max) {
      * over time to give greater weight to recent samples (exception: histogram counts are
      * cumulative for those systems that expect cumulative histogram buckets). Samples are
      * accumulated to such statistics in ring buffers which rotate after this expiry, with
-     * a buffer length of {@link #distributionStatisticBufferLength(Integer)}.
+     * a buffer length of {@link #distributionStatisticBufferLength(Integer)}, hence
+     * complete expiry happens after this expiry * buffer length.
      * @param expiry The amount of time samples are accumulated to a histogram before it
      * is reset and rotated.
      * @return This builder.

diff --git a/...src/main/java/io/micrometer/core/instrument/distribution/DistributionStatisticConfig.java b/...src/main/java/io/micrometer/core/instrument/distribution/DistributionStatisticConfig.java
@@ -214,7 +214,8 @@ public Double getMaximumExpectedValueAsDouble() {
      * greater weight to recent samples (exception: histogram counts are cumulative for
      * those systems that expect cumulative histogram buckets). Samples are accumulated to
      * such statistics in ring buffers which rotate after this expiry, with a buffer
-     * length of {@link #bufferLength}.
+     * length of {@link #bufferLength}, hence complete expiry happens after this expiry *
+     * buffer length.
      * @return The amount of time samples are accumulated to a histogram before it is
      * reset and rotated.
      */
@@ -426,7 +427,8 @@ public Builder maximumExpectedValue(@Nullable Double max) {
          * greater weight to recent samples (exception: histogram counts are cumulative
          * for those systems that expect cumulative histogram buckets). Samples are
          * accumulated to such statistics in ring buffers which rotate after this expiry,
-         * with a buffer length of {@link #bufferLength}.
+         * with a buffer length of {@link #bufferLength}, hence complete expiry happens
+         * after this expiry * buffer length.
          * @param expiry The amount of time samples are accumulated to decaying
          * distribution statistics before they are reset and rotated.
          * @return This builder.