From 9e6f5c8577ea50ece616b7d84bb5cb5194e4008c Mon Sep 17 00:00:00 2001 From: Brian Harrington Date: Thu, 18 Jan 2024 10:58:06 -0600 Subject: [PATCH] update timer docs for deprecation Update docs to stop recommending a deprecated method. --- docs/spectator/lang/java/meters/timer.md | 16 ++++------------ 1 file changed, 4 insertions(+), 12 deletions(-) diff --git a/docs/spectator/lang/java/meters/timer.md b/docs/spectator/lang/java/meters/timer.md index 6e2b1762..aca78e70 100644 --- a/docs/spectator/lang/java/meters/timer.md +++ b/docs/spectator/lang/java/meters/timer.md @@ -21,7 +21,7 @@ Then wrap the call you need to measure, preferably using a lambda: ```java public Response handle(Request request) { - return requestLatency.record(() -> handleImpl(request)); + return requestLatency.recordRunnable(() -> handleImpl(request)); } ``` @@ -75,9 +75,9 @@ public class MetadataService { ``` The id value returned by the `start` method is used to keep track of a particular task being -measured by the Timer. It must be stopped using the provided id. Note that unlike a regular Timer -that does not do anything until the final duration is recorded, a long duration Timer will report -as two Gauges: +measured by the LongTaskTimer. It must be stopped using the provided id. Note that unlike a +regular Timer that does not do anything until the final duration is recorded, a LongTaskTimer +will report as two Gauges: * `duration`: total duration spent within all currently running tasks. * `activeTasks`: number of currently running tasks. @@ -90,11 +90,3 @@ e.g., update a different Timer, if an exception is thrown. * Being a Gauge, it is inappropriate for short tasks. In particular, Gauges are sampled and if it is not sampled during the execution, or the sampling period is a significant subset of the expected duration, then the duration value will not be meaningful. - -Like a regular Timer, the duration Timer also supports using a lambda to simplify the common case: - -```java - private void refresh() { - metadataRefresh.record(this::refreshImpl); - } -```