Skip to content

Commit

Permalink
finagle/doc: fix link to default timer in metrics docs
Browse files Browse the repository at this point in the history
Problem:
The link to HashedWheelTimer was broken in the "Timer" section of Finagle
Metrics docs.

Solution:
Point link to c.t.finagle.util.DefaultTimer in GitHub. The implementation of
Finagle's default timer is Netty4HashedWheelTimer.

Differential Revision: https://phabricator.twitter.biz/D733144
  • Loading branch information
tigerlily-he authored and jenkins committed Aug 30, 2021
1 parent 26c4c5c commit 2fc7b57
Showing 1 changed file with 4 additions and 5 deletions.
9 changes: 4 additions & 5 deletions doc/src/sphinx/metrics/Finagle.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,13 +91,12 @@ Timer
<<<<<

**finagle/timer/pending_tasks** `verbosity:debug`
A stat of the number of pending tasks to run for
:src:`HashedWheelTimer.Default <com/twitter/finagle/util/HashedWheelTimer.scala>`.
A stat of the number of pending tasks to run for the
:src:`DefaultTimer <com/twitter/finagle/util/DefaultTimer.scala>`.

**finagle/timer/deviation_ms** `verbosity:debug`
A stat of the deviation in milliseconds of tasks scheduled on
:src:`HashedWheelTimer.Default <com/twitter/finagle/util/HashedWheelTimer.scala>`
from their expected time.
A stat of the deviation in milliseconds of tasks scheduled on the
:src:`DefaultTimer <com/twitter/finagle/util/DefaultTimer.scala>` from their expected time.

**finagle/timer/slow**
A counter of the number of tasks found to be executing for longer
Expand Down

0 comments on commit 2fc7b57

Please sign in to comment.