counter

package
v0.8.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Mar 15, 2024 License: Apache-2.0, BSD-3-Clause Imports: 2 Imported by: 0

Documentation

Overview

Package counter implements a simple counter system for collecting totally public telemetry data.

There are two kinds of counters, simple counters and stack counters. Simple counters are created by New(<counter-name>). Stack counters are created by NewStack(<counter-name>, depth). Both are incremented by calling Inc().

Counter files are stored in LocalDir(). Their content can be accessed by Parse().

Simple counters are very cheap. Stack counters are more expensive, as they require parsing the stack. (Stack counters are implemented as a set of regular counters whose names are the concatenation of the name and the stack trace. There is an upper limit on the size of this name, about 4K bytes. If the name is too long the stack will be truncated and "truncated" appended.)

When counter files expire they are turned into reports by the upload package. The first time any counter file is created for a user, a random day of the week is selected on which counter files will expire. For the first week, that day is more than 7 days (but not more than two weeks) in the future. After that the counter files expire weekly on the same day of the week.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Add

func Add(string, int64)

func CountFlags

func CountFlags(prefix string, fs flag.FlagSet)

func Inc

func Inc(string)

func Open

func Open()

Types

type Counter

type Counter struct {
	// contains filtered or unexported fields
}

func New

func New(name string) *Counter

func (*Counter) Add

func (c *Counter) Add(n int64)

func (*Counter) Inc

func (c *Counter) Inc()

func (*Counter) Name

func (c *Counter) Name() string

type StackCounter

type StackCounter struct {
	// contains filtered or unexported fields
}

func NewStack

func NewStack(name string, _ int) *StackCounter

func (*StackCounter) Counters

func (c *StackCounter) Counters() []*Counter

func (*StackCounter) Inc

func (c *StackCounter) Inc()

func (*StackCounter) Names

func (c *StackCounter) Names() []string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL