package stats

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

Dependency Relation
	imports 5 packages, and imported by 4 packages

Involved Source Files

	    handlers.go
	    metrics.go
	  d stats.go
		Package stats is for collecting and reporting various network and RPC stats.
		This package is for monitoring purpose only. All fields are read-only.
		All APIs are experimental.
Package-Level Type Names (total 18, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Begin (struct)
		Begin contains stats for the start of an RPC attempt.
		
		  - Server-side: Triggered after `InHeader`, as headers are processed
		    before the RPC lifecycle begins.
		  - Client-side: The first stats event recorded.
		
		FailFast is only valid if this Begin is from client side.

		Fields (total 6, all are exported)
			BeginTime time.Time
				BeginTime is the time when the RPC attempt begins.

			Client bool
				Client is true if this Begin is from client side.

			FailFast bool
				FailFast indicates if this RPC is failfast.

			IsClientStream bool
				IsClientStream indicates whether the RPC is a client streaming RPC.

			IsServerStream bool
				IsServerStream indicates whether the RPC is a server streaming RPC.

			IsTransparentRetryAttempt bool
				IsTransparentRetryAttempt indicates whether this attempt was initiated
				due to transparently retrying a previous attempt.

		Methods (total 2, in which 1 is exported)
			(*Begin) IsClient() bool
				IsClient indicates if the stats information is from client side.

			/* one unexported ... *//* one unexported: */
			(*Begin) isRPCStats()
		Implements (at least one exported)
			*Begin : RPCStats

	 type ConnBegin (struct)
		ConnBegin contains stats about connection establishment.

		Fields (only one, which is exported)
			Client bool
				Client is true if this ConnBegin is from client side.

		Methods (total 2, in which 1 is exported)
			(*ConnBegin) IsClient() bool
				IsClient indicates if this is from client side.

			/* one unexported ... *//* one unexported: */
			(*ConnBegin) isConnStats()
		Implements (at least one exported)
			*ConnBegin : ConnStats

	 type ConnEnd (struct)
		ConnEnd contains stats about connection termination.

		Fields (only one, which is exported)
			Client bool
				Client is true if this ConnBegin is from client side.

		Methods (total 2, in which 1 is exported)
			(*ConnEnd) IsClient() bool
				IsClient indicates if this is from client side.

			/* one unexported ... *//* one unexported: */
			(*ConnEnd) isConnStats()
		Implements (at least one exported)
			*ConnEnd : ConnStats

	 type ConnStats (interface)
		ConnStats contains stats information about connections.

		Methods (total 2, in which 1 is exported)
			( ConnStats) IsClient() bool
				IsClient returns true if this ConnStats is from client side.

			/* one unexported ... *//* one unexported: */
			( ConnStats) isConnStats()
		Implemented By (at least 2, both are exported)
			*ConnBegin
			*ConnEnd
		As Inputs Of (at least one exported)
			func Handler.HandleConn(context.Context, ConnStats)

	 type ConnTagInfo (struct)
		ConnTagInfo defines the relevant information needed by connection context tagger.

		Fields (total 2, both are exported)
			LocalAddr net.Addr
				LocalAddr is the local address of the corresponding connection.

			RemoteAddr net.Addr
				RemoteAddr is the remote address of the corresponding connection.

		As Inputs Of (at least one exported)
			func Handler.TagConn(context.Context, *ConnTagInfo) context.Context

	 type DelayedPickComplete (struct)
		DelayedPickComplete indicates that the RPC is unblocked following a delay in
		selecting a connection for the call.

		Methods (total 2, in which 1 is exported)
			(*DelayedPickComplete) IsClient() bool
				IsClient indicates DelayedPickComplete is available on the client.

			/* one unexported ... *//* one unexported: */
			(*DelayedPickComplete) isRPCStats()
		Implements (at least one exported)
			*DelayedPickComplete : RPCStats

	 type End (struct)
		End contains stats about RPC completion.

		Fields (total 5, all are exported)
			BeginTime time.Time
				BeginTime is the time when the RPC began.

			Client bool
				Client is true if this End is from client side.

			EndTime time.Time
				EndTime is the time when the RPC ends.

			Error error
				Error is the error the RPC ended with. It is an error generated from
				status.Status and can be converted back to status.Status using
				status.FromError if non-nil.

			Trailer metadata.MD
				Trailer contains the trailer metadata received from the server. This
				field is only valid if this End is from the client side.
				Deprecated: use Trailer in InTrailer instead.

		Methods (total 2, in which 1 is exported)
			(*End) IsClient() bool
				IsClient indicates if this is from client side.

			/* one unexported ... *//* one unexported: */
			(*End) isRPCStats()
		Implements (at least one exported)
			*End : RPCStats

	 type Handler (interface)
		Handler defines the interface for the related stats handling (e.g., RPCs, connections).

		Methods (total 4, all are exported)
			( Handler) HandleConn(context.Context, ConnStats)
				HandleConn processes the Conn stats.

			( Handler) HandleRPC(context.Context, RPCStats)
				HandleRPC processes the RPC stats.

			( Handler) TagConn(context.Context, *ConnTagInfo) context.Context
				TagConn can attach some information to the given context.
				The returned context will be used for stats handling.
				For conn stats handling, the context used in HandleConn for this
				connection will be derived from the context returned.
				For RPC stats handling,
				 - On server side, the context used in HandleRPC for all RPCs on this
				connection will be derived from the context returned.
				 - On client side, the context is not derived from the context returned.

			( Handler) TagRPC(context.Context, *RPCTagInfo) context.Context
				TagRPC can attach some information to the given context.
				The context used for the rest lifetime of the RPC will be derived from
				the returned context.

		As Inputs Of (at least 4, all are exported)
			func google.golang.org/grpc.StatsHandler(h Handler) grpc.ServerOption
			func google.golang.org/grpc.WithStatsHandler(h Handler) grpc.DialOption
			func google.golang.org/grpc/internal/stats.NewMetricsRecorderList(shs []Handler) *stats.MetricsRecorderList
			func google.golang.org/grpc/internal/transport.NewServerHandlerTransport(w http.ResponseWriter, r *http.Request, stats []Handler, bufferPool mem.BufferPool) (transport.ServerTransport, error)

	 type InHeader (struct)
		InHeader contains stats about header reception.
		
		- Server-side: The first stats event after the RPC request is received.

		Fields (total 7, all are exported)
			Client bool
				Client is true if this InHeader is from client side.

			Compression string
				Compression is the compression algorithm used for the RPC.

			FullMethod string
				The following fields are valid only if Client is false.
				FullMethod is the full RPC method string, i.e., /package.service/method.

			Header metadata.MD
				Header contains the header metadata received.

			LocalAddr net.Addr
				LocalAddr is the local address of the corresponding connection.

			RemoteAddr net.Addr
				RemoteAddr is the remote address of the corresponding connection.

			WireLength int
				WireLength is the wire length of header.

		Methods (total 2, in which 1 is exported)
			(*InHeader) IsClient() bool
				IsClient indicates if the stats information is from client side.

			/* one unexported ... *//* one unexported: */
			(*InHeader) isRPCStats()
		Implements (at least one exported)
			*InHeader : RPCStats

	 type InPayload (struct)
		InPayload contains stats about an incoming payload.

		Fields (total 6, all are exported)
			Client bool
				Client is true if this InPayload is from client side.

			CompressedLength int
				CompressedLength is the size of the compressed payload data. Does not
				include any framing (gRPC or HTTP/2). Same as Length if compression not
				enabled.

			Length int
				Length is the size of the uncompressed payload data. Does not include any
				framing (gRPC or HTTP/2).

			Payload any
				Payload is the payload with original type.  This may be modified after
				the call to HandleRPC which provides the InPayload returns and must be
				copied if needed later.

			RecvTime time.Time
				RecvTime is the time when the payload is received.

			WireLength int
				WireLength is the size of the compressed payload data plus gRPC framing.
				Does not include HTTP/2 framing.

		Methods (total 2, in which 1 is exported)
			(*InPayload) IsClient() bool
				IsClient indicates if the stats information is from client side.

			/* one unexported ... *//* one unexported: */
			(*InPayload) isRPCStats()
		Implements (at least one exported)
			*InPayload : RPCStats

	 type InTrailer (struct)
		InTrailer contains stats about trailer reception.

		Fields (total 3, all are exported)
			Client bool
				Client is true if this InTrailer is from client side.

			Trailer metadata.MD
				Trailer contains the trailer metadata received from the server. This
				field is only valid if this InTrailer is from the client side.

			WireLength int
				WireLength is the wire length of trailer.

		Methods (total 2, in which 1 is exported)
			(*InTrailer) IsClient() bool
				IsClient indicates if the stats information is from client side.

			/* one unexported ... *//* one unexported: */
			(*InTrailer) isRPCStats()
		Implements (at least one exported)
			*InTrailer : RPCStats

	 type MetricSet (struct)
		MetricSet is a set of metrics to record. Once created, MetricSet is immutable,
		however Add and Remove can make copies with specific metrics added or
		removed, respectively.
		
		Do not construct directly; use NewMetricSet instead.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			metrics map[string]bool
				metrics are the set of metrics to initialize.

		Methods (total 4, all are exported)
			(*MetricSet) Add(metricNames ...string) *MetricSet
				Add adds the metricNames to the metrics set and returns a new copy with the
				additional metrics.

			(*MetricSet) Join(metrics *MetricSet) *MetricSet
				Join joins the metrics passed in with the metrics set, and returns a new copy
				with the merged metrics.

			(*MetricSet) Metrics() map[string]bool
				Metrics returns the metrics set. The returned map is read-only and must not
				be modified.

			(*MetricSet) Remove(metricNames ...string) *MetricSet
				Remove removes the metricNames from the metrics set and returns a new copy
				with the metrics removed.

		As Outputs Of (at least 5, all are exported)
			func NewMetricSet(metricNames ...string) *MetricSet
			func (*MetricSet).Add(metricNames ...string) *MetricSet
			func (*MetricSet).Join(metrics *MetricSet) *MetricSet
			func (*MetricSet).Remove(metricNames ...string) *MetricSet
			func google.golang.org/grpc/experimental/stats.NewMetrics(metrics ...stats.Metric) *stats.Metrics
		As Inputs Of (at least one exported)
			func (*MetricSet).Join(metrics *MetricSet) *MetricSet
		As Types Of (only one, which is exported)
			  var google.golang.org/grpc/experimental/stats.DefaultMetrics *MetricSet

	 type OutHeader (struct)
		OutHeader contains stats about header transmission.
		
		  - Client-side: Only occurs after 'Begin', as headers are always the first
		    thing sent on a stream.

		Fields (total 6, all are exported)
			Client bool
				Client is true if this OutHeader is from client side.

			Compression string
				Compression is the compression algorithm used for the RPC.

			FullMethod string
				The following fields are valid only if Client is true.
				FullMethod is the full RPC method string, i.e., /package.service/method.

			Header metadata.MD
				Header contains the header metadata sent.

			LocalAddr net.Addr
				LocalAddr is the local address of the corresponding connection.

			RemoteAddr net.Addr
				RemoteAddr is the remote address of the corresponding connection.

		Methods (total 2, in which 1 is exported)
			(*OutHeader) IsClient() bool
				IsClient indicates if this stats information is from client side.

			/* one unexported ... *//* one unexported: */
			(*OutHeader) isRPCStats()
		Implements (at least one exported)
			*OutHeader : RPCStats

	 type OutPayload (struct)
		OutPayload contains stats about an outgoing payload.

		Fields (total 6, all are exported)
			Client bool
				Client is true if this OutPayload is from client side.

			CompressedLength int
				CompressedLength is the size of the compressed payload data. Does not
				include any framing (gRPC or HTTP/2). Same as Length if compression not
				enabled.

			Length int
				Length is the size of the uncompressed payload data. Does not include any
				framing (gRPC or HTTP/2).

			Payload any
				Payload is the payload with original type.  This may be modified after
				the call to HandleRPC which provides the OutPayload returns and must be
				copied if needed later.

			SentTime time.Time
				SentTime is the time when the payload is sent.

			WireLength int
				WireLength is the size of the compressed payload data plus gRPC framing.
				Does not include HTTP/2 framing.

		Methods (total 2, in which 1 is exported)
			(*OutPayload) IsClient() bool
				IsClient indicates if this stats information is from client side.

			/* one unexported ... *//* one unexported: */
			(*OutPayload) isRPCStats()
		Implements (at least one exported)
			*OutPayload : RPCStats
		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.outPayload(client bool, msg any, dataLength, payloadLength int, t time.Time) *OutPayload

	 type OutTrailer (struct)
		OutTrailer contains stats about trailer transmission.

		Fields (total 3, all are exported)
			Client bool
				Client is true if this InTrailer is from client side.

			Trailer metadata.MD
				Trailer contains the trailer metadata received from the server. This
				field is only valid if this InTrailer is from the client side.

			WireLength int
				WireLength is the wire length of trailer.

		Methods (total 2, in which 1 is exported)
			(*OutTrailer) IsClient() bool
				IsClient indicates if this stats information is from client side.

			/* one unexported ... *//* one unexported: */
			(*OutTrailer) isRPCStats()
		Implements (at least one exported)
			*OutTrailer : RPCStats

	 type PickerUpdated = DelayedPickComplete (struct)
		PickerUpdated indicates that the RPC is unblocked following a delay in
		selecting a connection for the call.
		
		Deprecated: will be removed in a future release; use DelayedPickComplete
		instead.

	 type RPCStats (interface)
		RPCStats contains stats information about RPCs.

		Methods (total 2, in which 1 is exported)
			( RPCStats) IsClient() bool
				IsClient returns true if this RPCStats is from client side.

			/* one unexported ... *//* one unexported: */
			( RPCStats) isRPCStats()
		Implemented By (at least 9, all are exported)
			*Begin
			*DelayedPickComplete
			*End
			*InHeader
			*InPayload
			*InTrailer
			*OutHeader
			*OutPayload
			*OutTrailer
		As Inputs Of (at least one exported)
			func Handler.HandleRPC(context.Context, RPCStats)

	 type RPCTagInfo (struct)
		RPCTagInfo defines the relevant information needed by RPC context tagger.

		Fields (total 3, all are exported)
			FailFast bool
				FailFast indicates if this RPC is failfast.
				This field is only valid on client side, it's always false on server side.

			FullMethodName string
				FullMethodName is the RPC method in the format of /package.service/method.

			NameResolutionDelay bool
				NameResolutionDelay indicates if the RPC needed to wait for the
				initial name resolver update before it could begin. This should only
				happen if the channel is IDLE when the RPC is started.  Note that
				all retry or hedging attempts for an RPC that experienced a delay
				will have it set.
				
				This field is only valid on the client side; it is always false on
				the server side.

		As Inputs Of (at least one exported)
			func Handler.TagRPC(context.Context, *RPCTagInfo) context.Context


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

	 func NewMetricSet(metricNames ...string) *MetricSet
		NewMetricSet returns a MetricSet containing metricNames.

	 func SetTags(ctx context.Context, b []byte) context.Context
		SetTags attaches stats tagging data to the context, which will be sent in
		the outgoing RPC with the header grpc-tags-bin.  Subsequent calls to
		SetTags will overwrite the values from earlier calls.
		
		Deprecated: set the `grpc-tags-bin` header in the metadata instead.

	 func SetTrace(ctx context.Context, b []byte) context.Context
		SetTrace attaches stats tagging data to the context, which will be sent in
		the outgoing RPC with the header grpc-trace-bin.  Subsequent calls to
		SetTrace will overwrite the values from earlier calls.
		
		Deprecated: set the `grpc-trace-bin` header in the metadata instead.

	 func Tags(ctx context.Context) []byte
		Tags returns the tags from the context for the inbound RPC.
		
		Deprecated: obtain the `grpc-tags-bin` header from metadata instead.

	 func Trace(ctx context.Context) []byte
		Trace returns the trace from the context for the inbound RPC.
		
		Deprecated: obtain the `grpc-trace-bin` header from metadata instead.

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