package metrics

Import Path
	github.com/tmc/go-iroh/metrics (on go.dev)

Dependency Relation
	imports 12 packages, and imported by one package

Involved Source Files

	  d doc.go
		Package metrics provides a small OpenMetrics registry for go-iroh metrics.
		
		The Go API is not stable before v1 and may change in any v0 release.

	    family.go
	    metrics.go
	    server.go
Package-Level Type Names (total 12)

	/* sort by: alphabet | popularity */
	 type Family (struct)
		Family is a metric vector keyed by a fixed label set.

		Methods (total 2)
			(*Family) StructuredSnapshot() StructuredSnapshot
				StructuredSnapshot returns all children in f.

			(*Family) With(labelValues ...string) (*FamilyMetric, error)
				With returns the child metric for labelValues.

		Implements (at least one exported)
			*Family : StructuredSource
		As Outputs Of (at least one exported)
			func NewFamily(name string, typ MetricType, labelNames ...string) *Family

	 type FamilyMetric (struct)
		FamilyMetric is one labeled metric in a [Family].

		Methods (total 2)
			(*FamilyMetric) Add(delta uint64)
				Add adds delta to m. Use it for counter families.

			(*FamilyMetric) Set(value float64)
				Set sets m to value. Use it for gauge families.

		As Outputs Of (at least one exported)
			func (*Family).With(labelValues ...string) (*FamilyMetric, error)

	 type HistogramBucket (struct)
		HistogramBucket is one cumulative histogram bucket.

		Fields (total 2)
			Count uint64
				Count is the cumulative count for this bucket.

			Le float64
				Le is the inclusive upper bound. Use math.Inf(1) for +Inf.

		As Inputs Of (at least one exported)
			func Histogram(sum float64, count uint64, buckets []HistogramBucket) MetricValue

	 type Label (struct)
		Label is one OpenMetrics label on a sample.

		Fields (total 2)
			Name string
			Value string

	 type MetricType string (basic type)
		MetricType is the OpenMetrics type of a metric value.

		As Inputs Of (at least one exported)
			func NewFamily(name string, typ MetricType, labelNames ...string) *Family
		As Types Of (total 3)
			const CounterMetric
			const GaugeMetric
			const HistogramMetric

	 type MetricValue (struct)
		MetricValue is one metric sample in a [StructuredSnapshot].

		Fields (total 8)
			Buckets []HistogramBucket
			Count uint64
			Counter uint64
			Gauge float64
			Labels []Label
			Name string
			Sum float64
			Type MetricType
		As Outputs Of (at least 3)
			func Counter(v uint64) MetricValue
			func Gauge(v float64) MetricValue
			func Histogram(sum float64, count uint64, buckets []HistogramBucket) MetricValue

	 type Registry (struct)
		Registry collects named metric sources.

		Methods (total 2)
			(*Registry) Register(prefix string, source any) error
				Register adds source under prefix. Prefix must be non-empty and unique.

			(*Registry) WriteOpenMetrics(w io.Writer) error
				WriteOpenMetrics writes all registered counter snapshots in OpenMetrics text
				format.

		As Outputs Of (at least one exported)
			func NewRegistry() *Registry
		As Inputs Of (at least 2)
			func Handler(r *Registry) http.Handler
			func NewServer(addr string, r *Registry) *Server

	 type Server (struct)
		Server is a small HTTP server for OpenMetrics scraping.

		Methods (total 3)
			(*Server) ListenAndServe() error
				ListenAndServe serves metrics until the server is shut down.

			(*Server) Serve(l net.Listener) error
				Serve serves metrics on l until the server is shut down.

			(*Server) Shutdown(ctx context.Context) error
				Shutdown gracefully shuts down the metrics server.

		As Outputs Of (at least one exported)
			func NewServer(addr string, r *Registry) *Server

	 type Snapshot (map)
		Snapshot is a point-in-time set of unsigned counter values.

		Methods (only one)
			( Snapshot) String() string
				String implements expvar.Var, returning the snapshot as JSON.

		Implements (at least 2)
			 Snapshot : expvar.Var
			 Snapshot : fmt.Stringer
		As Outputs Of (at least 2)
			func Source.Snapshot() Snapshot
			func github.com/tmc/go-iroh/iroh.Metrics.Snapshot() Snapshot

	 type Source (interface)
		Source returns a point-in-time metrics snapshot.

		Methods (only one)
			( Source) Snapshot() Snapshot
		Implemented By (at least one exported)
			 github.com/tmc/go-iroh/iroh.Metrics

	 type StructuredSnapshot (map)
		StructuredSnapshot is a point-in-time set of typed metric values.

		As Outputs Of (at least 2)
			func (*Family).StructuredSnapshot() StructuredSnapshot
			func StructuredSource.StructuredSnapshot() StructuredSnapshot

	 type StructuredSource (interface)
		StructuredSource returns a point-in-time typed metrics snapshot.

		Methods (only one)
			( StructuredSource) StructuredSnapshot() StructuredSnapshot
		Implemented By (at least one exported)
			*Family


Package-Level Functions (total 7)

	 func Counter(v uint64) MetricValue
		Counter returns a counter metric value.

	 func Gauge(v float64) MetricValue
		Gauge returns a gauge metric value.

	 func Handler(r *Registry) http.Handler
		Handler returns an HTTP handler serving r at /metrics.

	 func Histogram(sum float64, count uint64, buckets []HistogramBucket) MetricValue
		Histogram returns a histogram metric value. Buckets are copied and sorted by
		upper bound before OpenMetrics output.

	 func NewFamily(name string, typ MetricType, labelNames ...string) *Family
		NewFamily returns a metric family with labelNames in output order.

	 func NewRegistry() *Registry
		NewRegistry returns an empty registry.

	 func NewServer(addr string, r *Registry) *Server
		NewServer returns a metrics HTTP server bound to addr.


Package-Level Constants (total 3)

	const CounterMetric MetricType = "counter"
		CounterMetric is a monotonically increasing counter.

	const GaugeMetric MetricType = "gauge"
		GaugeMetric is a point-in-time value that may increase or decrease.

	const HistogramMetric MetricType = "histogram"
		HistogramMetric is a cumulative histogram.

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.