File: doc.go

package info (click to toggle)
golang-github-paulbellamy-ratecounter 0.2.0%2Bgit20170719.a803f0e-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 108 kB
  • sloc: makefile: 3
file content (24 lines) | stat: -rw-r--r-- 641 bytes parent folder | download | duplicates (3)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/*
Package ratecounter provides a thread-safe rate-counter, for tracking counts
in an interval

Useful for implementing counters and stats of 'requests-per-second' (for example).

  // We're recording marks-per-1second
  counter := ratecounter.NewRateCounter(1 * time.Second)

  // Record an event happening
  counter.Mark()

  // get the current requests-per-second
  counter.Rate()

To record an average over a longer period, you can:

  // Record requests-per-minute
  counter := ratecounter.NewRateCounter(60 * time.Second)

  // Calculate the average requests-per-second for the last minute
  counter.Rate() / 60
*/
package ratecounter