package flow

Import Path
	github.com/libp2p/go-flow-metrics (on go.dev)

Dependency Relation
	imports 6 packages, and imported by one package

Involved Source Files

	    meter.go
	    registry.go
	    sweeper.go
Package-Level Type Names (total 3)

	/* sort by: alphabet | popularity */
	 type Meter (struct)
		Meter is a meter for monitoring a flow.

		Methods (total 4)
			(*Meter) Mark(count uint64)
				Mark updates the total.

			(*Meter) Reset()
				Reset sets accumulator, total and rate to zero.

			(*Meter) Snapshot() Snapshot
				Snapshot gets a snapshot of the total and rate.

			(*Meter) String() string
		Implements (at least 2)
			*Meter : expvar.Var
			*Meter : fmt.Stringer
		As Outputs Of (at least 2)
			func NewMeter() *Meter
			func (*MeterRegistry).Get(name string) *Meter

	 type MeterRegistry (struct)
		MeterRegistry is a registry for named meters.

		Methods (total 6)
			(*MeterRegistry) Clear()
				Clear removes all meters from the registry.

			(*MeterRegistry) FindIdle(since time.Time) []string
				FindIdle finds all meters that haven't been used since the given time.

			(*MeterRegistry) ForEach(iterFunc func(string, *Meter))
				ForEach calls the passed function for each registered meter.

			(*MeterRegistry) Get(name string) *Meter
				Get gets (or creates) a meter by name.

			(*MeterRegistry) Remove(name string)
				Remove removes the named meter from the registry.
				
				Note: The only reason to do this is to save a bit of memory. Unused meters
				don't consume any CPU (after they go idle).

			(*MeterRegistry) TrimIdle(since time.Time) (trimmed int)
				TrimIdle trims that haven't been updated since the given time. Returns the
				number of timers trimmed.


	 type Snapshot (struct)
		Snapshot is a rate/total snapshot.

		Fields (total 3)
			LastUpdate time.Time
			Rate float64
			Total uint64
		Methods (only one)
			( Snapshot) String() string
		Implements (at least 2)
			 Snapshot : expvar.Var
			 Snapshot : fmt.Stringer
		As Outputs Of (at least one exported)
			func (*Meter).Snapshot() Snapshot


Package-Level Functions (total 2)

	 func NewMeter() *Meter
		NewMeter returns a new Meter with the correct idle time.
		
		While zero-value Meters can be used, their "last update" time will start at
		the program start instead of when the meter was created.

	 func SetClock(c clock.Clock)
		SetClock sets a clock to use in the sweeper.
		This will probably only ever be useful for testing purposes.


Package-Level Variables (only one)

	  var IdleRate float64
		IdleRate the rate at which we declare a meter idle (and stop tracking it
		until it's re-registered).
		
		The default ensures that 1 event every ~30s will keep the meter from going
		idle.

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.