Documentation
¶
Index ¶
- type Provider
- func (p *Provider) All() map[string]any
- func (p *Provider) Clear()
- func (p *Provider) Counter(name string) metrics.Counter
- func (p *Provider) Gatherer() prometheus.Gatherer
- func (p *Provider) Histogram(name string) metrics.Histogram
- func (*Provider) Info() metrics.Info
- func (p *Provider) InstrumentHandler(handler http.Handler, label string) http.Handler
- func (p *Provider) MarshalJSON() ([]byte, error)
- func (p *Provider) MustRegister(cs ...prometheus.Collector)
- func (p *Provider) Register(c prometheus.Collector) error
- func (p *Provider) RegisterEndpoints(registrar func(path, method string, handler http.Handler))
- func (p *Provider) Timer(name string) metrics.Timer
- func (p *Provider) Unregister(c prometheus.Collector) bool
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Provider ¶
type Provider struct {
// contains filtered or unexported fields
}
Provider wraps a metrics.Metrics provider with a Prometheus registry that can instrument the HTTP server's handlers.
func (*Provider) All ¶
All returns the union of the inner metric provider and the underlying prometheus registry.
func (*Provider) Clear ¶
func (p *Provider) Clear()
Clear resets the inner metric provider. The Prometheus registry does not expose an interface to clear the metrics so this call has no affect on metrics tracked by Prometheus.
func (*Provider) Gatherer ¶ added in v1.16.0
func (p *Provider) Gatherer() prometheus.Gatherer
Gatherer returns the underlying prometheus.Gatherer for exporting metrics via OTLP.
func (*Provider) InstrumentHandler ¶
InstrumentHandler returned wrapped HTTP handler with added prometheus instrumentation
func (*Provider) MarshalJSON ¶
MarshalJSON returns a JSON representation of the unioned metrics.
func (*Provider) MustRegister ¶ added in v0.38.0
func (p *Provider) MustRegister(cs ...prometheus.Collector)
MustRegister register the collectors on OPA prometheus registry and panics when an error occurs
func (*Provider) Register ¶ added in v0.38.0
func (p *Provider) Register(c prometheus.Collector) error
Register register the collectors on OPA prometheus registry
func (*Provider) RegisterEndpoints ¶
RegisterEndpoints registers `/metrics` endpoint
func (*Provider) Unregister ¶ added in v0.38.0
func (p *Provider) Unregister(c prometheus.Collector) bool
Unregister unregister the collectors on OPA prometheus registry
Source Files