package stats

Import Path
	google.golang.org/grpc/experimental/stats (on go.dev)

Dependency Relation
	imports 4 packages, and imported by 5 packages

Involved Source Files

	    metricregistry.go
	  d metrics.go
		Package stats contains experimental metrics/stats API's.
Package-Level Type Names (total 10, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Float64CountHandle MetricDescriptor (struct)
		Float64CountHandle is a typed handle for a float count metric. This handle is
		passed at the recording point in order to know which metric to record on.

		Fields (total 8, all are exported)
			Bounds []float64
				Bounds are the bounds of this metric. This only applies to histogram
				metrics. If unset or set with length 0, stats handlers will fall back to
				default bounds.

			Default bool
				Whether this metric is on by default.

			Description string
				The description of this metric.

			Labels []string
				The required label keys for this metric. These are intended to
				metrics emitted from a stats handler.

			Name string
				The name of this metric. This name must be unique across the whole binary
				(including any per call metrics). See
				https://github.com/grpc/proposal/blob/master/A79-non-per-call-metrics-architecture.md#metric-instrument-naming-conventions
				for metric naming conventions.

			OptionalLabels []string
				The optional label keys for this metric. These are intended to attached
				to metrics emitted from a stats handler if configured.

			Type MetricType
				The type of metric. This is set by the metric registry, and not intended
				to be set by a component registering a metric.

			Unit string
				The unit (e.g. entries, seconds) of this metric.

		Methods (total 2, both are exported)
			(*Float64CountHandle) Descriptor() *MetricDescriptor
				Descriptor returns the float64 count handle typecast to a pointer to a
				MetricDescriptor.

			(*Float64CountHandle) Record(recorder MetricsRecorder, incr float64, labels ...string)
				Record records the float64 count value on the metrics recorder provided.

		As Outputs Of (at least one exported)
			func RegisterFloat64Count(descriptor MetricDescriptor) *Float64CountHandle
		As Inputs Of (at least 2, both are exported)
			func MetricsRecorder.RecordFloat64Count(handle *Float64CountHandle, incr float64, labels ...string)
			func google.golang.org/grpc/internal/stats.(*MetricsRecorderList).RecordFloat64Count(handle *Float64CountHandle, incr float64, labels ...string)

	 type Float64HistoHandle MetricDescriptor (struct)
		Float64HistoHandle is a typed handle for a float histogram metric. This
		handle is passed at the recording point in order to know which metric to
		record on.

		Fields (total 8, all are exported)
			Bounds []float64
				Bounds are the bounds of this metric. This only applies to histogram
				metrics. If unset or set with length 0, stats handlers will fall back to
				default bounds.

			Default bool
				Whether this metric is on by default.

			Description string
				The description of this metric.

			Labels []string
				The required label keys for this metric. These are intended to
				metrics emitted from a stats handler.

			Name string
				The name of this metric. This name must be unique across the whole binary
				(including any per call metrics). See
				https://github.com/grpc/proposal/blob/master/A79-non-per-call-metrics-architecture.md#metric-instrument-naming-conventions
				for metric naming conventions.

			OptionalLabels []string
				The optional label keys for this metric. These are intended to attached
				to metrics emitted from a stats handler if configured.

			Type MetricType
				The type of metric. This is set by the metric registry, and not intended
				to be set by a component registering a metric.

			Unit string
				The unit (e.g. entries, seconds) of this metric.

		Methods (total 2, both are exported)
			(*Float64HistoHandle) Descriptor() *MetricDescriptor
				Descriptor returns the float64 histo handle typecast to a pointer to a
				MetricDescriptor.

			(*Float64HistoHandle) Record(recorder MetricsRecorder, incr float64, labels ...string)
				Record records the float64 histo value on the metrics recorder provided.

		As Outputs Of (at least one exported)
			func RegisterFloat64Histo(descriptor MetricDescriptor) *Float64HistoHandle
		As Inputs Of (at least 2, both are exported)
			func MetricsRecorder.RecordFloat64Histo(handle *Float64HistoHandle, incr float64, labels ...string)
			func google.golang.org/grpc/internal/stats.(*MetricsRecorderList).RecordFloat64Histo(handle *Float64HistoHandle, incr float64, labels ...string)

	 type Int64CountHandle MetricDescriptor (struct)
		Int64CountHandle is a typed handle for a int count metric. This handle
		is passed at the recording point in order to know which metric to record
		on.

		Fields (total 8, all are exported)
			Bounds []float64
				Bounds are the bounds of this metric. This only applies to histogram
				metrics. If unset or set with length 0, stats handlers will fall back to
				default bounds.

			Default bool
				Whether this metric is on by default.

			Description string
				The description of this metric.

			Labels []string
				The required label keys for this metric. These are intended to
				metrics emitted from a stats handler.

			Name string
				The name of this metric. This name must be unique across the whole binary
				(including any per call metrics). See
				https://github.com/grpc/proposal/blob/master/A79-non-per-call-metrics-architecture.md#metric-instrument-naming-conventions
				for metric naming conventions.

			OptionalLabels []string
				The optional label keys for this metric. These are intended to attached
				to metrics emitted from a stats handler if configured.

			Type MetricType
				The type of metric. This is set by the metric registry, and not intended
				to be set by a component registering a metric.

			Unit string
				The unit (e.g. entries, seconds) of this metric.

		Methods (total 2, both are exported)
			(*Int64CountHandle) Descriptor() *MetricDescriptor
				Descriptor returns the int64 count handle typecast to a pointer to a
				MetricDescriptor.

			(*Int64CountHandle) Record(recorder MetricsRecorder, incr int64, labels ...string)
				Record records the int64 count value on the metrics recorder provided.

		As Outputs Of (at least one exported)
			func RegisterInt64Count(descriptor MetricDescriptor) *Int64CountHandle
		As Inputs Of (at least 2, both are exported)
			func MetricsRecorder.RecordInt64Count(handle *Int64CountHandle, incr int64, labels ...string)
			func google.golang.org/grpc/internal/stats.(*MetricsRecorderList).RecordInt64Count(handle *Int64CountHandle, incr int64, labels ...string)
		As Types Of (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			  var google.golang.org/grpc/balancer/pickfirst/pickfirstleaf.connectionAttemptsFailedMetric *Int64CountHandle
			  var google.golang.org/grpc/balancer/pickfirst/pickfirstleaf.connectionAttemptsSucceededMetric *Int64CountHandle
			  var google.golang.org/grpc/balancer/pickfirst/pickfirstleaf.disconnectionsMetric *Int64CountHandle

	 type Int64GaugeHandle MetricDescriptor (struct)
		Int64GaugeHandle is a typed handle for an int gauge metric. This handle is
		passed at the recording point in order to know which metric to record on.

		Fields (total 8, all are exported)
			Bounds []float64
				Bounds are the bounds of this metric. This only applies to histogram
				metrics. If unset or set with length 0, stats handlers will fall back to
				default bounds.

			Default bool
				Whether this metric is on by default.

			Description string
				The description of this metric.

			Labels []string
				The required label keys for this metric. These are intended to
				metrics emitted from a stats handler.

			Name string
				The name of this metric. This name must be unique across the whole binary
				(including any per call metrics). See
				https://github.com/grpc/proposal/blob/master/A79-non-per-call-metrics-architecture.md#metric-instrument-naming-conventions
				for metric naming conventions.

			OptionalLabels []string
				The optional label keys for this metric. These are intended to attached
				to metrics emitted from a stats handler if configured.

			Type MetricType
				The type of metric. This is set by the metric registry, and not intended
				to be set by a component registering a metric.

			Unit string
				The unit (e.g. entries, seconds) of this metric.

		Methods (total 2, both are exported)
			(*Int64GaugeHandle) Descriptor() *MetricDescriptor
				Descriptor returns the int64 gauge handle typecast to a pointer to a
				MetricDescriptor.

			(*Int64GaugeHandle) Record(recorder MetricsRecorder, incr int64, labels ...string)
				Record records the int64 histo value on the metrics recorder provided.

		As Outputs Of (at least one exported)
			func RegisterInt64Gauge(descriptor MetricDescriptor) *Int64GaugeHandle
		As Inputs Of (at least 2, both are exported)
			func MetricsRecorder.RecordInt64Gauge(handle *Int64GaugeHandle, incr int64, labels ...string)
			func google.golang.org/grpc/internal/stats.(*MetricsRecorderList).RecordInt64Gauge(handle *Int64GaugeHandle, incr int64, labels ...string)

	 type Int64HistoHandle MetricDescriptor (struct)
		Int64HistoHandle is a typed handle for an int histogram metric. This handle
		is passed at the recording point in order to know which metric to record on.

		Fields (total 8, all are exported)
			Bounds []float64
				Bounds are the bounds of this metric. This only applies to histogram
				metrics. If unset or set with length 0, stats handlers will fall back to
				default bounds.

			Default bool
				Whether this metric is on by default.

			Description string
				The description of this metric.

			Labels []string
				The required label keys for this metric. These are intended to
				metrics emitted from a stats handler.

			Name string
				The name of this metric. This name must be unique across the whole binary
				(including any per call metrics). See
				https://github.com/grpc/proposal/blob/master/A79-non-per-call-metrics-architecture.md#metric-instrument-naming-conventions
				for metric naming conventions.

			OptionalLabels []string
				The optional label keys for this metric. These are intended to attached
				to metrics emitted from a stats handler if configured.

			Type MetricType
				The type of metric. This is set by the metric registry, and not intended
				to be set by a component registering a metric.

			Unit string
				The unit (e.g. entries, seconds) of this metric.

		Methods (total 2, both are exported)
			(*Int64HistoHandle) Descriptor() *MetricDescriptor
				Descriptor returns the int64 histo handle typecast to a pointer to a
				MetricDescriptor.

			(*Int64HistoHandle) Record(recorder MetricsRecorder, incr int64, labels ...string)
				Record records the int64 histo value on the metrics recorder provided.

		As Outputs Of (at least one exported)
			func RegisterInt64Histo(descriptor MetricDescriptor) *Int64HistoHandle
		As Inputs Of (at least 2, both are exported)
			func MetricsRecorder.RecordInt64Histo(handle *Int64HistoHandle, incr int64, labels ...string)
			func google.golang.org/grpc/internal/stats.(*MetricsRecorderList).RecordInt64Histo(handle *Int64HistoHandle, incr int64, labels ...string)

	 type Metric = string (basic type)
		Metric was replaced by direct usage of strings.

	 type MetricDescriptor (struct)
		MetricDescriptor is the data for a registered metric.

		Fields (total 8, all are exported)
			Bounds []float64
				Bounds are the bounds of this metric. This only applies to histogram
				metrics. If unset or set with length 0, stats handlers will fall back to
				default bounds.

			Default bool
				Whether this metric is on by default.

			Description string
				The description of this metric.

			Labels []string
				The required label keys for this metric. These are intended to
				metrics emitted from a stats handler.

			Name string
				The name of this metric. This name must be unique across the whole binary
				(including any per call metrics). See
				https://github.com/grpc/proposal/blob/master/A79-non-per-call-metrics-architecture.md#metric-instrument-naming-conventions
				for metric naming conventions.

			OptionalLabels []string
				The optional label keys for this metric. These are intended to attached
				to metrics emitted from a stats handler if configured.

			Type MetricType
				The type of metric. This is set by the metric registry, and not intended
				to be set by a component registering a metric.

			Unit string
				The unit (e.g. entries, seconds) of this metric.

		As Outputs Of (at least 6, all are exported)
			func DescriptorForMetric(metricName string) *MetricDescriptor
			func (*Float64CountHandle).Descriptor() *MetricDescriptor
			func (*Float64HistoHandle).Descriptor() *MetricDescriptor
			func (*Int64CountHandle).Descriptor() *MetricDescriptor
			func (*Int64GaugeHandle).Descriptor() *MetricDescriptor
			func (*Int64HistoHandle).Descriptor() *MetricDescriptor
		As Inputs Of (at least 6, in which 5 are exported)
			func RegisterFloat64Count(descriptor MetricDescriptor) *Float64CountHandle
			func RegisterFloat64Histo(descriptor MetricDescriptor) *Float64HistoHandle
			func RegisterInt64Count(descriptor MetricDescriptor) *Int64CountHandle
			func RegisterInt64Gauge(descriptor MetricDescriptor) *Int64GaugeHandle
			func RegisterInt64Histo(descriptor MetricDescriptor) *Int64HistoHandle
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc/internal/stats.verifyLabels(desc *MetricDescriptor, labelsRecv ...string)

	 type Metrics = stats.MetricSet (struct)
		Metrics is an experimental legacy alias of the now-stable stats.MetricSet.
		Metrics will be deleted in a future release.

	 type MetricsRecorder (interface)
		MetricsRecorder records on metrics derived from metric registry.

		Methods (total 5, all are exported)
			( MetricsRecorder) RecordFloat64Count(handle *Float64CountHandle, incr float64, labels ...string)
				RecordFloat64Count records the measurement alongside labels on the float
				count associated with the provided handle.

			( MetricsRecorder) RecordFloat64Histo(handle *Float64HistoHandle, incr float64, labels ...string)
				RecordFloat64Histo records the measurement alongside labels on the float
				histo associated with the provided handle.

			( MetricsRecorder) RecordInt64Count(handle *Int64CountHandle, incr int64, labels ...string)
				RecordInt64Count records the measurement alongside labels on the int
				count associated with the provided handle.

			( MetricsRecorder) RecordInt64Gauge(handle *Int64GaugeHandle, incr int64, labels ...string)
				RecordInt64Gauge records the measurement alongside labels on the int
				gauge associated with the provided handle.

			( MetricsRecorder) RecordInt64Histo(handle *Int64HistoHandle, incr int64, labels ...string)
				RecordInt64Histo records the measurement alongside labels on the int
				histo associated with the provided handle.

		Implemented By (at least one exported)
			*google.golang.org/grpc/internal/stats.MetricsRecorderList
		As Outputs Of (at least one exported)
			func google.golang.org/grpc/balancer.ClientConn.MetricsRecorder() MetricsRecorder
		As Inputs Of (at least 5, all are exported)
			func (*Float64CountHandle).Record(recorder MetricsRecorder, incr float64, labels ...string)
			func (*Float64HistoHandle).Record(recorder MetricsRecorder, incr float64, labels ...string)
			func (*Int64CountHandle).Record(recorder MetricsRecorder, incr int64, labels ...string)
			func (*Int64GaugeHandle).Record(recorder MetricsRecorder, incr int64, labels ...string)
			func (*Int64HistoHandle).Record(recorder MetricsRecorder, incr int64, labels ...string)

	 type MetricType int (basic type)
		MetricType is the type of metric.

		As Types Of (total 5, all are exported)
			const MetricTypeFloatCount
			const MetricTypeFloatHisto
			const MetricTypeIntCount
			const MetricTypeIntGauge
			const MetricTypeIntHisto


Package-Level Functions (total 10, in which 7 are exported)

	 func DescriptorForMetric(metricName string) *MetricDescriptor
		DescriptorForMetric returns the MetricDescriptor from the global registry.
		
		Returns nil if MetricDescriptor not present.

	 func NewMetrics(metrics ...Metric) *Metrics
		NewMetrics is an experimental legacy alias of the now-stable
		stats.NewMetricSet.  NewMetrics will be deleted in a future release.

	 func RegisterFloat64Count(descriptor MetricDescriptor) *Float64CountHandle
		RegisterFloat64Count registers the metric description onto the global
		registry. It returns a typed handle to use to recording data.
		
		NOTE: this function must only be called during initialization time (i.e. in
		an init() function), and is not thread-safe. If multiple metrics are
		registered with the same name, this function will panic.

	 func RegisterFloat64Histo(descriptor MetricDescriptor) *Float64HistoHandle
		RegisterFloat64Histo registers the metric description onto the global
		registry. It returns a typed handle to use to recording data.
		
		NOTE: this function must only be called during initialization time (i.e. in
		an init() function), and is not thread-safe. If multiple metrics are
		registered with the same name, this function will panic.

	 func RegisterInt64Count(descriptor MetricDescriptor) *Int64CountHandle
		RegisterInt64Count registers the metric description onto the global registry.
		It returns a typed handle to use to recording data.
		
		NOTE: this function must only be called during initialization time (i.e. in
		an init() function), and is not thread-safe. If multiple metrics are
		registered with the same name, this function will panic.

	 func RegisterInt64Gauge(descriptor MetricDescriptor) *Int64GaugeHandle
		RegisterInt64Gauge registers the metric description onto the global registry.
		It returns a typed handle to use to recording data.
		
		NOTE: this function must only be called during initialization time (i.e. in
		an init() function), and is not thread-safe. If multiple metrics are
		registered with the same name, this function will panic.

	 func RegisterInt64Histo(descriptor MetricDescriptor) *Int64HistoHandle
		RegisterInt64Histo registers the metric description onto the global registry.
		It returns a typed handle to use to recording data.
		
		NOTE: this function must only be called during initialization time (i.e. in
		an init() function), and is not thread-safe. If multiple metrics are
		registered with the same name, this function will panic.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func init()
	 func registerMetric(metricName string, def bool)
	 func snapshotMetricsRegistryForTesting() func()
		snapshotMetricsRegistryForTesting snapshots the global data of the metrics
		registry. Returns a cleanup function that sets the metrics registry to its
		original state.


Package-Level Variables (total 4, in which 1 is exported)

	  var DefaultMetrics *stats.MetricSet
		DefaultMetrics are the default metrics registered through global metrics
		registry. This is written to at initialization time only, and is read only
		after initialization.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	  var logger grpclog.DepthLoggerV2
	  var metricsRegistry map[string]*MetricDescriptor
		metricsRegistry contains all of the registered metrics.
		
		This is written to only at init time, and read only after that.

	  var registeredMetrics map[string]bool
		registeredMetrics are the registered metric descriptor names.


Package-Level Constants (total 5, all are exported)

	const MetricTypeFloatCount MetricType = 1
		Type of metric supported by this instrument registry.

	const MetricTypeFloatHisto MetricType = 3
		Type of metric supported by this instrument registry.

	const MetricTypeIntCount MetricType = 0
		Type of metric supported by this instrument registry.

	const MetricTypeIntGauge MetricType = 4
		Type of metric supported by this instrument registry.

	const MetricTypeIntHisto MetricType = 2
		Type of metric supported by this instrument registry.

The pages are generated with Golds v0.7.6. (GOOS=linux GOARCH=amd64)