metrics

package

v1.2.6 Latest Latest Go to latest Published: Jan 11, 2018 License: MIT Imports: 21 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

View Source

const (
	// MetricsSubmissionTimeout is the timeout for a metrics submission request
	MetricsSubmissionTimeout = 45 * time.Second
)

This section is empty.

func Disable(conf *config.Config) error

Disable metrics

func Enable(conf *config.Config) error

Enable metrics

func Purge() (err error)

Purge current metrics file

func Rec(conf *config.Config, e Event)

Rec event if analytics is enabled

func RecOrFail(conf *config.Config, e Event) (saved bool, err error)

RecOrFail records event if analytics is enabled and returns an error on failure

func Reset(conf *config.Config) error

Reset metrics by regenerating metrics ID and purge existing metrics

func SetPID(p int) (uniquePID string)

SetPID enhances real PID with prefix to distinguish between repeating PIDs

func SetPath(path string)

SetPath sets the path for the metric file

func SubmitEventuallyOnBackground(conf *config.Config) (err error)

SubmitEventuallyOnBackground eventually forks a child process that submits analytics to WeDeploy if the analytics reporting is enabled

type Event struct {
	Type  string
	Text  string
	Tags  []string
	Extra map[string]string
}

Event entry see also collector.Event

type Sender struct {
	Purge bool
	// contains filtered or unexported fields
}

Sender for the metrics

func (s *Sender) TrySubmit(conf *config.Config) (int, error)

TrySubmit events file if enabled