package stats

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

Dependency Relation
	imports 6 packages, and imported by 2 packages

Involved Source Files

	  d labels.go
		Package stats provides internal stats related functionality.

	    metrics_recorder_list.go
	    stats.go
Package-Level Type Names (total 5, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type LabelCallback (func)
		LabelCallback is a function that is executed when telemetry
		label keys are updated.

		As Inputs Of (at least one exported)
			func RegisterTelemetryLabelCallback(ctx context.Context, callback LabelCallback) context.Context

	 type MetricsRecorderList (struct)
		MetricsRecorderList forwards Record calls to all of its metricsRecorders.
		
		It eats any record calls where the label values provided do not match the
		number of label keys.

		Fields (total 2, in which 1 is exported)
			EnforceMetricsRecorderEmbedding internal.EnforceMetricsRecorderEmbedding
			/* one unexported ... *//* one unexported: */
			metricsRecorders []estats.MetricsRecorder
				metricsRecorders are the metrics recorders this list will forward to.

		Methods (total 8, in which 7 are exported)
			(*MetricsRecorderList) RecordFloat64Count(handle *estats.Float64CountHandle, incr float64, labels ...string)
				RecordFloat64Count records the measurement alongside labels on the float
				count associated with the provided handle.

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

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

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

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

			(*MetricsRecorderList) RecordInt64UpDownCount(handle *estats.Int64UpDownCountHandle, incr int64, labels ...string)
				RecordInt64UpDownCount records the measurement alongside labels on the int
				count associated with the provided handle.

			(*MetricsRecorderList) RegisterAsyncReporter(reporter estats.AsyncMetricReporter, metrics ...estats.AsyncMetric) func()
				RegisterAsyncReporter forwards the registration to all underlying metrics
				recorders.
				
				It returns a cleanup function that, when called, invokes the cleanup function
				returned by each underlying recorder, ensuring the reporter is unregistered
				from all of them.

			/* one unexported ... *//* one unexported: */
			( MetricsRecorderList) enforceMetricsRecorderEmbedding()
		Implements (at least 2, both are exported)
			 MetricsRecorderList : google.golang.org/grpc/internal.EnforceMetricsRecorderEmbedding
			*MetricsRecorderList : google.golang.org/grpc/experimental/stats.MetricsRecorder
		As Outputs Of (at least one exported)
			func NewMetricsRecorderList(shs []stats.Handler) *MetricsRecorderList

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type asyncRecorderWrapper (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			delegate estats.AsyncMetricsRecorder
			descriptors map[*estats.MetricDescriptor]bool
		Methods (only one, which is exported)
			(*asyncRecorderWrapper) RecordInt64AsyncGauge(handle *estats.Int64AsyncGaugeHandle, value int64, labels ...string)
				RecordIntAsync64Gauge records the measurement alongside labels on the int
				gauge associated with the provided handle.

		Implements (at least one exported)
			*asyncRecorderWrapper : google.golang.org/grpc/experimental/stats.AsyncMetricsRecorder

	 type combinedHandler (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			handlers []stats.Handler
		Methods (total 4, all are exported)
			(*combinedHandler) HandleConn(ctx context.Context, stats stats.ConnStats)
			(*combinedHandler) HandleRPC(ctx context.Context, stats stats.RPCStats)
			(*combinedHandler) TagConn(ctx context.Context, info *stats.ConnTagInfo) context.Context
			(*combinedHandler) TagRPC(ctx context.Context, info *stats.RPCTagInfo) context.Context
		Implements (at least one exported)
			*combinedHandler : google.golang.org/grpc/stats.Handler

	 type telemetryLabelCallbackKey (struct)
Package-Level Functions (total 7, in which 4 are exported)

	 func NewCombinedHandler(handlers ...stats.Handler) stats.Handler
		NewCombinedHandler combines multiple stats.Handlers into a single handler.
		
		It returns nil if no handlers are provided. If only one handler is
		provided, it is returned directly without wrapping.

	 func NewMetricsRecorderList(shs []stats.Handler) *MetricsRecorderList
		NewMetricsRecorderList creates a new metric recorder list with all the stats
		handlers provided which implement the MetricsRecorder interface.
		If no stats handlers provided implement the MetricsRecorder interface,
		the MetricsRecorder list returned is a no-op.

	 func RegisterTelemetryLabelCallback(ctx context.Context, callback LabelCallback) context.Context
		RegisterTelemetryLabelCallback registers a callback function that is executed whenever
		telemetry labels are updated.

	 func UpdateLabels(ctx context.Context, update map[string]string)
		UpdateLabels executes registered telemetry callbacks with the update labels. Labels
		are copied before being processed by any callbacks to ensure mutations are not
		shared among derived contexts.
		
		It is the responsibility of the registrant to handle conflicts or label resets.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func defaultCleanUp(unregisterFns []func()) func()
	 func executeTelemetryLabelCallbacks(ctx context.Context, labels map[string]string)
		executeTelemetryLabelCallback runs the registered callbacks in the order they were
		registered on the context with the provided labels. If no callbacks are registered
		it does nothing.
		
		To ensure callbacks do not mutate the state of the provided label map it is copied
		before execution.

	 func verifyLabels(desc *estats.MetricDescriptor, labelsRecv ...string)

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