metrics

package

v1.2.16 Latest Latest Go to latest Published: Jan 16, 2023 License: MIT Imports: 6 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

Repository

github.com/storageos/api-manager

Documentation ¶

Index ¶

Variables
func InstrumentedTransport(t http.RoundTripper) http.RoundTripper
func RegisterMetrics()
type LatencyMetric
type ResultMetric

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// Latency is the latency metric that wrappered or composite api calls will
	// update.
	Latency LatencyMetric = &latencyAdapter{m: helperLatencyHistogram}

	// Errors counts errors encountered by api helpers.
	Errors ResultMetric = &resultAdapter{m: helperResultCounter}
)

Functions ¶

func InstrumentedTransport ¶

func InstrumentedTransport(t http.RoundTripper) http.RoundTripper

InstrumentedTransport is middleware that wraps the provided http.RoundTripper, adding the default Prometheus http client metrics.

The transport should be re-used between clients or the metrics will get lost/re-initialised.

func RegisterMetrics ¶

func RegisterMetrics()

RegisterMetrics ensures that the package metrics are registered.

Types ¶

type LatencyMetric ¶

type LatencyMetric interface {
	Observe(function string, latency time.Duration)
}

LatencyMetric observes latency of wrappered or composite api calls.

type ResultMetric ¶

type ResultMetric interface {
	Increment(function string, err error)
}

ResultMetric counts wrappered function errors.

Source Files ¶

View all Source files

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