package stats

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

Dependency Relation
	imports 4 packages, and imported by 2 packages

Involved Source Files

	      handlers.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 19, in which 15 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Begin (struct)
		Begin contains stats when an RPC attempt begins.
		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 are 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 the stats of a connection when it is established.

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

		Methods (total 2, in which 1 are 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 the stats of a connection when it ends.

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

		Methods (total 2, in which 1 are 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 are 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 End (struct)
		End contains stats when an RPC ends.

		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 are 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 3, 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/transport.NewServerHandlerTransport(w http.ResponseWriter, r *http.Request, stats []Handler) (transport.ServerTransport, error)

	 type InHeader (struct)
		InHeader contains stats when a header 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 are 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 the information for an incoming payload.

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

			Data []byte
				Data is the serialized message payload.

			Length int
				Length is the length of uncompressed data.

			Payload interface{}
				Payload is the payload with original type.

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

			WireLength int
				WireLength is the length of data on wire (compressed, signed, encrypted).

		Methods (total 2, in which 1 are 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 when a trailer is received.

		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 are 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 OutHeader (struct)
		OutHeader contains stats when a header is sent.

		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 are 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 the information for an outgoing payload.

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

			Data []byte
				Data is the serialized message payload.

			Length int
				Length is the length of uncompressed data.

			Payload interface{}
				Payload is the payload with original type.

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

			WireLength int
				WireLength is the length of data on wire (compressed, signed, encrypted).

		Methods (total 2, in which 1 are 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 interface{}, data, payload []byte, t time.Time) *OutPayload

	 type OutTrailer (struct)
		OutTrailer contains stats when a trailer is sent.

		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 are 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 RPCStats (interface)
		RPCStats contains stats information about RPCs.

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

			/* one unexported ... *//* one unexported: */
			( RPCStats) isRPCStats()
		Implemented By (at least 8, all are exported)
			*Begin
			*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 2, both 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.

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

	/* 4 unexporteds ... *//* 4 unexporteds: */
	 type incomingTagsKey (struct)
	 type incomingTraceKey (struct)
	 type outgoingTagsKey (struct)
	 type outgoingTraceKey (struct)
Package-Level Functions (total 8, all are exported)

	 func OutgoingTags(ctx context.Context) []byte
		OutgoingTags returns the tags from the context for the outbound RPC.

		This is intended for gRPC-internal use ONLY.

	 func OutgoingTrace(ctx context.Context) []byte
		OutgoingTrace returns the trace from the context for the outbound RPC.  It is
		intended for gRPC-internal use.

	 func SetIncomingTags(ctx context.Context, b []byte) context.Context
		SetIncomingTags attaches stats tagging data to the context, to be read by
		the application (not sent in outgoing RPCs).

		This is intended for gRPC-internal use ONLY.

	 func SetIncomingTrace(ctx context.Context, b []byte) context.Context
		SetIncomingTrace attaches stats tagging data to the context, to be read by
		the application (not sent in outgoing RPCs).  It is intended for
		gRPC-internal use.

	 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.

		NOTE: this is provided only for backward compatibility with existing clients
		and will likely be removed in an upcoming release.  New uses should transmit
		this type of data using metadata with a different, non-reserved (i.e. does
		not begin with "grpc-") header name.

	 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.

		NOTE: this is provided only for backward compatibility with existing clients
		and will likely be removed in an upcoming release.  New uses should transmit
		this type of data using metadata with a different, non-reserved (i.e. does
		not begin with "grpc-") header name.

	 func Tags(ctx context.Context) []byte
		Tags returns the tags from the context for the inbound RPC.

		NOTE: this is provided only for backward compatibility with existing clients
		and will likely be removed in an upcoming release.  New uses should transmit
		this type of data using metadata with a different, non-reserved (i.e. does
		not begin with "grpc-") header name.

	 func Trace(ctx context.Context) []byte
		Trace returns the trace from the context for the inbound RPC.

		NOTE: this is provided only for backward compatibility with existing clients
		and will likely be removed in an upcoming release.  New uses should transmit
		this type of data using metadata with a different, non-reserved (i.e. does
		not begin with "grpc-") header name.

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