instrumentation

package

v0.0.0-...-20fe154 Latest Latest Go to latest Published: Feb 21, 2020 License: Apache-2.0 Imports: 7 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

This section is empty.

This section is empty.

This section is empty.

type Instrumentation struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Instrumentation holds the instrumentation definitions and log on a package to

ensure every service behaves exactly the same.

func New(ipPort string, debug bool) (*Instrumentation, error)

New returns an Instrumentation object

func (i *Instrumentation) Debug(msg string, fields ...zap.Field)

Debug uses the zap.Logger logging functionality

func (i *Instrumentation) Error(msg string, fields ...zap.Field)

Error uses the zap.Logger logging functionality

func (i *Instrumentation) Hostname() string

Hostname returns the name of the host being instrumented

func (i *Instrumentation) Info(msg string, fields ...zap.Field)

Info uses the zap.Logger logging functionality

func (i *Instrumentation) Metric(name string) prometheus.Collector

Metric returns a metric from the map safely

func (i *Instrumentation) RegisterCounter(name, help string, labels []string)

RegisterCounter registers gauges

func (i *Instrumentation) RegisterGauge(name, help string, labels []string)

RegisterGauge registers gauges

func (i *Instrumentation) RegisterHistogram(name, help string, labels []string, buckets []float64)

RegisterHistogram registers a new histogram to be consumed by Prometheus

func (i *Instrumentation) RegisterSummary(name, help string, labels []string)

RegisterSummary registers a new summany to be consumed by Prometheus

func (i *Instrumentation) Shutdown() error

Shutdown stops the instrumentation server

func (i *Instrumentation) Start() error

Start the instrumentation server