package channelz

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

Dependency Relation
	imports 9 packages, and imported by 3 packages

Involved Source Files

	   d➜ funcs.go
		Package channelz defines APIs for enabling channelz service, entry
		registration/deletion, and accessing channelz data. It also defines channelz
		metric struct formats.

		All APIs in this package are experimental.

	      logging.go
	      types.go
	      types_nonlinux.go
	      util_nonlinux.go
Package-Level Type Names (total 30, in which 16 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Channel (interface)
		Channel is the interface that should be satisfied in order to be tracked by
		channelz as Channel or SubChannel.

		Methods (only one, which is exported)
			( T) ChannelzMetric() *ChannelInternalMetric
		Implemented By (at least 3, none are exported)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*dummyChannel
			*google.golang.org/grpc.addrConn
			*google.golang.org/grpc.channelzChannel
		As Inputs Of (at least 2, both are exported)
			func RegisterChannel(c Channel, pid int64, ref string) int64
			func RegisterSubChannel(c Channel, pid int64, ref string) int64

	 type ChannelInternalMetric (struct)
		ChannelInternalMetric defines the struct that the implementor of Channel interface
		should return from ChannelzMetric().

		Fields (total 6, all are exported)
			CallsFailed int64
				The number of calls that have a completed with a non-OK status.

			CallsStarted int64
				The number of calls started on the channel.

			CallsSucceeded int64
				The number of calls that have completed with an OK status.

			LastCallStartedTimestamp time.Time
				The last time a call was started on the channel.

			State connectivity.State
				current connectivity state of the channel.

			Target string
				The target this channel originally tried to connect to.  May be absent

		As Outputs Of (at least 2, in which 1 are exported)
			func Channel.ChannelzMetric() *ChannelInternalMetric
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.(*ClientConn).channelzMetric() *ChannelInternalMetric

	 type ChannelMetric (struct)
		ChannelMetric defines the info channelz provides for a specific Channel, which
		includes ChannelInternalMetric and channelz-specific data, such as channelz id,
		child list, etc.

		Fields (total 7, all are exported)
			ChannelData *ChannelInternalMetric
				ChannelData contains channel internal metric reported by the channel through
				ChannelzMetric().

			ID int64
				ID is the channelz id of this channel.

			NestedChans map[int64]string
				NestedChans tracks the nested channel type children of this channel in the format of
				a map from nested channel channelz id to corresponding reference string.

			RefName string
				RefName is the human readable reference string of this channel.

			Sockets map[int64]string
				Sockets tracks the socket type children of this channel in the format of a map
				from socket channelz id to corresponding reference string.
				Note current grpc implementation doesn't allow channel having sockets directly,
				therefore, this is field is unused.

			SubChans map[int64]string
				SubChans tracks the subchannel type children of this channel in the format of a
				map from subchannel channelz id to corresponding reference string.

			Trace *ChannelTrace
				Trace contains the most recent traced events.

		As Outputs Of (at least 2, both are exported)
			func GetChannel(id int64) *ChannelMetric
			func GetTopChannels(id int64, maxResults int64) ([]*ChannelMetric, bool)

	 type ChannelTrace (struct)
		ChannelTrace stores traced events on a channel/subchannel and related info.

		Fields (total 3, all are exported)
			CreationTime time.Time
				CreationTime is the creation time of the trace.

			EventNum int64
				EventNum is the number of events that ever got traced (i.e. including those that have been deleted)

			Events []*TraceEvent
				Events stores the most recent trace events (up to $maxTraceEntry, newer event will overwrite the
				oldest one)


	 type RefChannelType int (basic type)
		RefChannelType is the type of the entity being referenced in a trace event.

		As Types Of (total 2, both are exported)
			const RefChannel
			const RefSubChannel

	 type Server (interface)
		Server is the interface to be satisfied in order to be tracked by channelz as
		Server.

		Methods (only one, which is exported)
			( T) ChannelzMetric() *ServerInternalMetric
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*google.golang.org/grpc.channelzServer
		As Inputs Of (at least one exported)
			func RegisterServer(s Server, ref string) int64

	 type ServerInternalMetric (struct)
		ServerInternalMetric defines the struct that the implementor of Server interface
		should return from ChannelzMetric().

		Fields (total 4, all are exported)
			CallsFailed int64
				The number of incoming calls that have a completed with a non-OK status.

			CallsStarted int64
				The number of incoming calls started on the server.

			CallsSucceeded int64
				The number of incoming calls that have completed with an OK status.

			LastCallStartedTimestamp time.Time
				The last time a call was started on the server.

		As Outputs Of (at least 2, in which 1 are exported)
			func Server.ChannelzMetric() *ServerInternalMetric
			/* at least one unexported ... *//* at least one unexported: */
			func google.golang.org/grpc.(*Server).channelzMetric() *ServerInternalMetric

	 type ServerMetric (struct)
		ServerMetric defines the info channelz provides for a specific Server, which
		includes ServerInternalMetric and channelz-specific data, such as channelz id,
		child list, etc.

		Fields (total 4, all are exported)
			ID int64
				ID is the channelz id of this server.

			ListenSockets map[int64]string
				ListenSockets tracks the listener socket type children of this server in the
				format of a map from socket channelz id to corresponding reference string.

			RefName string
				RefName is the human readable reference string of this server.

			ServerData *ServerInternalMetric
				ServerData contains server internal metric reported by the server through
				ChannelzMetric().

		As Outputs Of (at least 2, both are exported)
			func GetServer(id int64) *ServerMetric
			func GetServers(id int64, maxResults int64) ([]*ServerMetric, bool)

	 type Severity int (basic type)
		Severity is the severity level of a trace event.
		The canonical enumeration of all valid values is here:
		https://github.com/grpc/grpc-proto/blob/9b13d199cc0d4703c7ea26c9c330ba695866eb23/grpc/channelz/v1/channelz.proto#L126.

		As Types Of (total 4, all are exported)
			const CtError
			const CtINFO
			const CtUNKNOWN
			const CtWarning

	 type Socket (interface)
		Socket is the interface that should be satisfied in order to be tracked by
		channelz as Socket.

		Methods (only one, which is exported)
			( T) ChannelzMetric() *SocketInternalMetric
		Implemented By (at least 3, none are exported)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*google.golang.org/grpc/internal/transport.http2Client
			*google.golang.org/grpc/internal/transport.http2Server
			*google.golang.org/grpc.listenSocket
		As Inputs Of (at least 2, both are exported)
			func RegisterListenSocket(s Socket, pid int64, ref string) int64
			func RegisterNormalSocket(s Socket, pid int64, ref string) int64

	 type SocketInternalMetric (struct)
		SocketInternalMetric defines the struct that the implementor of Socket interface
		should return from ChannelzMetric().

		Fields (total 17, all are exported)
			KeepAlivesSent int64
				The number of keep alives sent.  This is typically implemented with HTTP/2
				ping messages.

			LastLocalStreamCreatedTimestamp time.Time
				The last time a stream was created by this endpoint.  Usually unset for
				servers.

			LastMessageReceivedTimestamp time.Time
				The last time a message was received by this endpoint.

			LastMessageSentTimestamp time.Time
				The last time a message was sent by this endpoint.

			LastRemoteStreamCreatedTimestamp time.Time
				The last time a stream was created by the remote endpoint.  Usually unset
				for clients.

			LocalAddr net.Addr
				The locally bound address.

			LocalFlowControlWindow int64
				The amount of window, granted to the local endpoint by the remote endpoint.
				This may be slightly out of date due to network latency.  This does NOT
				include stream level or TCP level flow control info.

			MessagesReceived int64
			MessagesSent int64
				The number of messages successfully sent on this socket.

			RemoteAddr net.Addr
				The remote bound address.  May be absent.

			RemoteFlowControlWindow int64
				The amount of window, granted to the remote endpoint by the local endpoint.
				This may be slightly out of date due to network latency.  This does NOT
				include stream level or TCP level flow control info.

			RemoteName string
				Optional, represents the name of the remote endpoint, if different than
				the original target name.

			Security credentials.ChannelzSecurityValue
			SocketOptions *SocketOptionData
			StreamsFailed int64
				The number of streams that have ended unsuccessfully:
				On client side, termination without receiving frame with eos bit set.
				On server side, termination without sending frame with eos bit set.

			StreamsStarted int64
				The number of streams that have been started.

			StreamsSucceeded int64
				The number of streams that have ended successfully:
				On client side, receiving frame with eos bit set.
				On server side, sending frame with eos bit set.

		As Outputs Of (at least one exported)
			func Socket.ChannelzMetric() *SocketInternalMetric

	 type SocketMetric (struct)
		SocketMetric defines the info channelz provides for a specific Socket, which
		includes SocketInternalMetric and channelz-specific data, such as channelz id, etc.

		Fields (total 3, all are exported)
			ID int64
				ID is the channelz id of this socket.

			RefName string
				RefName is the human readable reference string of this socket.

			SocketData *SocketInternalMetric
				SocketData contains socket internal metric reported by the socket through
				ChannelzMetric().

		As Outputs Of (at least 2, both are exported)
			func GetServerSockets(id int64, startID int64, maxResults int64) ([]*SocketMetric, bool)
			func GetSocket(id int64) *SocketMetric

	 type SocketOptionData (struct)
		SocketOptionData defines the struct to hold socket option data, and related
		getter function to obtain info from fd.
		Windows OS doesn't support Socket Option

		Methods (only one, which is exported)
			(*T) Getsockopt(fd uintptr)
				Getsockopt defines the function to get socket options requested by channelz.
				It is to be passed to syscall.RawConn.Control().
				Windows OS doesn't support Socket Option

		As Outputs Of (at least one exported)
			func GetSocketOption(c interface{}) *SocketOptionData

	 type SubChannelMetric (struct)
		SubChannelMetric defines the info channelz provides for a specific SubChannel,
		which includes ChannelInternalMetric and channelz-specific data, such as
		channelz id, child list, etc.

		Fields (total 7, all are exported)
			ChannelData *ChannelInternalMetric
				ChannelData contains channel internal metric reported by the channel through
				ChannelzMetric().

			ID int64
				ID is the channelz id of this channel.

			NestedChans map[int64]string
				NestedChans tracks the nested channel type children of this channel in the format of
				a map from nested channel channelz id to corresponding reference string.

			RefName string
				RefName is the human readable reference string of this channel.

			Sockets map[int64]string
				Sockets tracks the socket type children of this channel in the format of a map
				from socket channelz id to corresponding reference string.
				Note current grpc implementation doesn't allow channel having sockets directly,
				therefore, this is field is unused.

			SubChans map[int64]string
				SubChans tracks the subchannel type children of this channel in the format of a
				map from subchannel channelz id to corresponding reference string.

			Trace *ChannelTrace
				Trace contains the most recent traced events.

		As Outputs Of (at least one exported)
			func GetSubChannel(id int64) *SubChannelMetric

	 type TraceEvent (struct)
		TraceEvent represent a single trace event

		Fields (total 6, all are exported)
			Desc string
				Desc is a simple description of the trace event.

			RefID int64
				RefID is the id of the entity that gets referenced in the event. RefID is 0 if no other entity is
				involved in this event.
				e.g. SubChannel (id: 4[]) Created. --> RefID = 4, RefName = "" (inside [])

			RefName string
				RefName is the reference name for the entity that gets referenced in the event.

			RefType RefChannelType
				RefType indicates the referenced entity type, i.e Channel or SubChannel.

			Severity Severity
				Severity states the severity of this trace event.

			Timestamp time.Time
				Timestamp is the event time.


	 type TraceEventDesc (struct)
		TraceEventDesc is what the caller of AddTraceEvent should provide to describe the event to be added
		to the channel trace.
		The Parent field is optional. It is used for event that will be recorded in the entity's parent
		trace also.

		Fields (total 3, all are exported)
			Desc string
			Parent *TraceEventDesc
			Severity Severity
		As Inputs Of (at least one exported)
			func AddTraceEvent(l grpclog.DepthLoggerV2, id int64, depth int, desc *TraceEventDesc)

	/* 14 unexporteds ... *//* 14 unexporteds: */
	 type channel (struct)

		Fields (total 10, none are exported)
			/* 10 unexporteds ... *//* 10 unexporteds: */
			c Channel
			closeCalled bool
			cm *channelMap
			id int64
			nestedChans map[int64]string
			pid int64
			refName string
			subChans map[int64]string
			trace *channelTrace
			traceRefCount int32
				traceRefCount is the number of trace events that reference this channel.
				Non-zero traceRefCount means the trace of this channel cannot be deleted.

		Methods (total 12, none are exported)
			/* 12 unexporteds ... *//* 12 unexporteds: */
			(*T) addChild(id int64, e entry)
			(*T) decrTraceRefCount()
			(*T) deleteChild(id int64)
			(*T) deleteSelfFromMap() (delete bool)
				deleteSelfFromMap checks whether it is valid to delete the channel from the map, which means
				deleting the channel from channelz's tracking entirely. Users can no longer use id to query the
				channel, and its memory will be garbage collected.

				The trace reference count of the channel must be 0 in order to be deleted from the map. This is
				specified in the channel tracing gRFC that as long as some other trace has reference to an entity,
				the trace of the referenced entity must not be deleted. In order to release the resource allocated
				by grpc, the reference to the grpc object is reset to a dummy object.

				deleteSelfFromMap must be called after deleteSelfFromTree returns true.

				It returns a bool to indicate whether the channel can be safely deleted from map.

			(*T) deleteSelfFromTree() (deleted bool)
				deleteSelfFromTree tries to delete the channel from the channelz entry relation tree, which means
				deleting the channel reference from its parent's child list.

				In order for a channel to be deleted from the tree, it must meet the criteria that, removal of the
				corresponding grpc object has been invoked, and the channel does not have any children left.

				The returned boolean value indicates whether the channel has been successfully deleted from tree.

			(*T) deleteSelfIfReady()
				deleteSelfIfReady tries to delete the channel itself from the channelz database.
				The delete process includes two steps:
				1. delete the channel from the entry relation tree, i.e. delete the channel reference from its
				   parent's child list.
				2. delete the channel from the map, i.e. delete the channel entirely from channelz. Lookup by id
				   will return entry not found error.

			(*T) getChannelTrace() *channelTrace
			(*T) getParentID() int64
			(*T) getRefName() string
			(*T) getTraceRefCount() int
			(*T) incrTraceRefCount()
			(*T) triggerDelete()
		Implements (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*T : entry
			*T : tracedChannel

	 type channelMap (struct)
		channelMap is the storage data structure for channelz.
		Methods of channelMap can be divided in two two categories with respect to locking.
		1. Methods acquire the global lock.
		2. Methods that can only be called when global lock is held.
		A second type of method need always to be called inside a first type of method.

		Fields (total 7, none are exported)
			/* 7 unexporteds ... *//* 7 unexporteds: */
			channels map[int64]*channel
			listenSockets map[int64]*listenSocket
			mu sync.RWMutex
			normalSockets map[int64]*normalSocket
			servers map[int64]*server
			subChannels map[int64]*subChannel
			topLevelChannels map[int64]struct{}
		Methods (total 17, in which 7 are exported)
			(*T) GetChannel(id int64) *ChannelMetric
			(*T) GetServer(id int64) *ServerMetric
			(*T) GetServerSockets(id int64, startID int64, maxResults int64) ([]*SocketMetric, bool)
			(*T) GetServers(id, maxResults int64) ([]*ServerMetric, bool)
			(*T) GetSocket(id int64) *SocketMetric
			(*T) GetSubChannel(id int64) *SubChannelMetric
			(*T) GetTopChannels(id int64, maxResults int64) ([]*ChannelMetric, bool)
			/* 10 unexporteds ... *//* 10 unexporteds: */
			(*T) addChannel(id int64, cn *channel, isTopChannel bool, pid int64, ref string)
			(*T) addListenSocket(id int64, ls *listenSocket, pid int64, ref string)
			(*T) addNormalSocket(id int64, ns *normalSocket, pid int64, ref string)
			(*T) addServer(id int64, s *server)
			(*T) addSubChannel(id int64, sc *subChannel, pid int64, ref string)
			(*T) decrTraceRefCount(id int64)
				c.mu must be held by the caller

			(*T) deleteEntry(id int64)
				c.mu must be held by the caller
				deleteEntry simply deletes an entry from the channelMap. Before calling this
				method, caller must check this entry is ready to be deleted, i.e removeEntry()
				has been called on it, and no children still exist.
				Conditionals are ordered by the expected frequency of deletion of each entity
				type, in order to optimize performance.

			(*T) findEntry(id int64) entry
				c.mu must be held by the caller.

			(*T) removeEntry(id int64)
				removeEntry triggers the removal of an entry, which may not indeed delete the entry, if it has to
				wait on the deletion of its children and until no other entity's channel trace references it.
				It may lead to a chain of entry deletion. For example, deleting the last socket of a gracefully
				shutting down server will lead to the server being also deleted.

			(*T) traceEvent(id int64, desc *TraceEventDesc)

	 type channelTrace (struct)

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			cm *channelMap
			createdTime time.Time
			eventCount int64
			events []*TraceEvent
			mu sync.Mutex
		Methods (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			(*T) append(e *TraceEvent)
			(*T) clear()
			(*T) dumpData() *ChannelTrace

	 type dbWrapper (struct)
		dbWarpper wraps around a reference to internal channelz data storage, and
		provide synchronized functionality to set and get the reference.

		Fields (total 2, in which 1 are exported)
			DB *channelMap
			/* one unexported ... *//* one unexported: */
			mu sync.RWMutex
		Methods (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) get() *channelMap
			(*T) set(db *channelMap)
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var db

	 type dummyChannel (struct)

		Methods (only one, which is exported)
			(*T) ChannelzMetric() *ChannelInternalMetric
		Implements (at least one exported)
			*T : Channel

	 type dummyEntry (struct)
		dummyEntry is a fake entry to handle entry not found case.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			idNotFound int64
		Methods (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) addChild(id int64, e entry)
			(*T) deleteChild(id int64)
			(*T) deleteSelfIfReady()
			(*T) getParentID() int64
			(*T) triggerDelete()
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*T : entry

	 type entry (interface)
		entry represents a node in the channelz database.

		Methods (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			( T) addChild(id int64, e entry)
				addChild adds a child e, whose channelz id is id to child list

			( T) deleteChild(id int64)
				deleteChild deletes a child with channelz id to be id from child list

			( T) deleteSelfIfReady()
				deleteSelfIfReady check whether triggerDelete() has been called before, and whether child
				list is now empty. If both conditions are met, then delete self from database.

			( T) getParentID() int64
				getParentID returns parent ID of the entry. 0 value parent ID means no parent.

			( T) triggerDelete()
				triggerDelete tries to delete self from channelz database. However, if child
				list is not empty, then deletion from the database is on hold until the last
				child is deleted from database.

		Implemented By (at least 6, none are exported)
			/* 6+ unexporteds ... *//* 6+ unexporteds: */
			*channel
			*dummyEntry
			*listenSocket
			*normalSocket
			*server
			*subChannel

	 type idGenerator (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			id int64
		Methods (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			(*T) genID() int64
			(*T) reset()
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var idGen

	 type int64Slice ([]T)

		Methods (total 3, all are exported)
			( T) Len() int
			( T) Less(i, j int) bool
			( T) Swap(i, j int)
		Implements (at least 2, in which 1 are exported)
			 T : sort.Interface
			/* at least one unexported ... *//* at least one unexported: */
			 T : github.com/aws/aws-sdk-go/aws/corehandlers.lener

	 type listenSocket (struct)

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			cm *channelMap
			id int64
			pid int64
			refName string
			s Socket
		Methods (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) addChild(id int64, e entry)
			(*T) deleteChild(id int64)
			(*T) deleteSelfIfReady()
			(*T) getParentID() int64
			(*T) triggerDelete()
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*T : entry

	 type normalSocket (struct)

		Fields (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			cm *channelMap
			id int64
			pid int64
			refName string
			s Socket
		Methods (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) addChild(id int64, e entry)
			(*T) deleteChild(id int64)
			(*T) deleteSelfIfReady()
			(*T) getParentID() int64
			(*T) triggerDelete()
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*T : entry

	 type server (struct)

		Fields (total 7, none are exported)
			/* 7 unexporteds ... *//* 7 unexporteds: */
			closeCalled bool
			cm *channelMap
			id int64
			listenSockets map[int64]string
			refName string
			s Server
			sockets map[int64]string
		Methods (total 5, none are exported)
			/* 5 unexporteds ... *//* 5 unexporteds: */
			(*T) addChild(id int64, e entry)
			(*T) deleteChild(id int64)
			(*T) deleteSelfIfReady()
			(*T) getParentID() int64
			(*T) triggerDelete()
		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*T : entry

	 type subChannel (struct)

		Fields (total 9, none are exported)
			/* 9 unexporteds ... *//* 9 unexporteds: */
			c Channel
			closeCalled bool
			cm *channelMap
			id int64
			pid int64
			refName string
			sockets map[int64]string
			trace *channelTrace
			traceRefCount int32
		Methods (total 12, none are exported)
			/* 12 unexporteds ... *//* 12 unexporteds: */
			(*T) addChild(id int64, e entry)
			(*T) decrTraceRefCount()
			(*T) deleteChild(id int64)
			(*T) deleteSelfFromMap() (delete bool)
				deleteSelfFromMap checks whether it is valid to delete the subchannel from the map, which means
				deleting the subchannel from channelz's tracking entirely. Users can no longer use id to query
				the subchannel, and its memory will be garbage collected.

				The trace reference count of the subchannel must be 0 in order to be deleted from the map. This is
				specified in the channel tracing gRFC that as long as some other trace has reference to an entity,
				the trace of the referenced entity must not be deleted. In order to release the resource allocated
				by grpc, the reference to the grpc object is reset to a dummy object.

				deleteSelfFromMap must be called after deleteSelfFromTree returns true.

				It returns a bool to indicate whether the channel can be safely deleted from map.

			(*T) deleteSelfFromTree() (deleted bool)
				deleteSelfFromTree tries to delete the subchannel from the channelz entry relation tree, which
				means deleting the subchannel reference from its parent's child list.

				In order for a subchannel to be deleted from the tree, it must meet the criteria that, removal of
				the corresponding grpc object has been invoked, and the subchannel does not have any children left.

				The returned boolean value indicates whether the channel has been successfully deleted from tree.

			(*T) deleteSelfIfReady()
				deleteSelfIfReady tries to delete the subchannel itself from the channelz database.
				The delete process includes two steps:
				1. delete the subchannel from the entry relation tree, i.e. delete the subchannel reference from
				   its parent's child list.
				2. delete the subchannel from the map, i.e. delete the subchannel entirely from channelz. Lookup
				   by id will return entry not found error.

			(*T) getChannelTrace() *channelTrace
			(*T) getParentID() int64
			(*T) getRefName() string
			(*T) getTraceRefCount() int
			(*T) incrTraceRefCount()
			(*T) triggerDelete()
		Implements (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*T : entry
			*T : tracedChannel

	 type tracedChannel (interface)

		Methods (total 4, none are exported)
			/* 4 unexporteds ... *//* 4 unexporteds: */
			( T) decrTraceRefCount()
			( T) getChannelTrace() *channelTrace
			( T) getRefName() string
			( T) incrTraceRefCount()
		Implemented By (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*channel
			*subChannel


Package-Level Functions (total 29, in which 26 are exported)

	 func AddTraceEvent(l grpclog.DepthLoggerV2, id int64, depth int, desc *TraceEventDesc)
		AddTraceEvent adds trace related to the entity with specified id, using the provided TraceEventDesc.

	 func Error(l grpclog.DepthLoggerV2, id int64, args ...interface{})
		Error logs and adds a trace event if channelz is on.

	 func Errorf(l grpclog.DepthLoggerV2, id int64, format string, args ...interface{})
		Errorf logs and adds a trace event if channelz is on.

	 func GetChannel(id int64) *ChannelMetric
		GetChannel returns the ChannelMetric for the channel (identified by id).

	 func GetServer(id int64) *ServerMetric
		GetServer returns the ServerMetric for the server (identified by id).

	 func GetServers(id int64, maxResults int64) ([]*ServerMetric, bool)
		GetServers returns a slice of server's ServerMetric, along with a
		boolean indicating whether there's more servers to be queried for.

		The arg id specifies that only server with id at or above it will be included
		in the result. The returned slice is up to a length of the arg maxResults or
		EntryPerPage if maxResults is zero, and is sorted in ascending id order.

	 func GetServerSockets(id int64, startID int64, maxResults int64) ([]*SocketMetric, bool)
		GetServerSockets returns a slice of server's (identified by id) normal socket's
		SocketMetric, along with a boolean indicating whether there's more sockets to
		be queried for.

		The arg startID specifies that only sockets with id at or above it will be
		included in the result. The returned slice is up to a length of the arg maxResults
		or EntryPerPage if maxResults is zero, and is sorted in ascending id order.

	 func GetSocket(id int64) *SocketMetric
		GetSocket returns the SocketInternalMetric for the socket (identified by id).

	 func GetSocketOption(c interface{}) *SocketOptionData
		GetSocketOption gets the socket option info of the conn.

	 func GetSubChannel(id int64) *SubChannelMetric
		GetSubChannel returns the SubChannelMetric for the subchannel (identified by id).

	 func GetTopChannels(id int64, maxResults int64) ([]*ChannelMetric, bool)
		GetTopChannels returns a slice of top channel's ChannelMetric, along with a
		boolean indicating whether there's more top channels to be queried for.

		The arg id specifies that only top channel with id at or above it will be included
		in the result. The returned slice is up to a length of the arg maxResults or
		EntryPerPage if maxResults is zero, and is sorted in ascending id order.

	 func Info(l grpclog.DepthLoggerV2, id int64, args ...interface{})
		Info logs and adds a trace event if channelz is on.

	 func Infof(l grpclog.DepthLoggerV2, id int64, format string, args ...interface{})
		Infof logs and adds a trace event if channelz is on.

	 func IsOn() bool
		IsOn returns whether channelz data collection is on.

	 func NewChannelzStorage() (cleanup func() error)
		NewChannelzStorage initializes channelz data storage and id generator.

		This function returns a cleanup function to wait for all channelz state to be reset by the
		grpc goroutines when those entities get closed. By using this cleanup function, we make sure tests
		don't mess up each other, i.e. lingering goroutine from previous test doing entity removal happen
		to remove some entity just register by the new test, since the id space is the same.

		Note: This function is exported for testing purpose only. User should not call
		it in most cases.

	 func RegisterChannel(c Channel, pid int64, ref string) int64
		RegisterChannel registers the given channel c in channelz database with ref
		as its reference name, and add it to the child list of its parent (identified
		by pid). pid = 0 means no parent. It returns the unique channelz tracking id
		assigned to this channel.

	 func RegisterListenSocket(s Socket, pid int64, ref string) int64
		RegisterListenSocket registers the given listen socket s in channelz database
		with ref as its reference name, and add it to the child list of its parent
		(identified by pid). It returns the unique channelz tracking id assigned to
		this listen socket.

	 func RegisterNormalSocket(s Socket, pid int64, ref string) int64
		RegisterNormalSocket registers the given normal socket s in channelz database
		with ref as its reference name, and add it to the child list of its parent
		(identified by pid). It returns the unique channelz tracking id assigned to
		this normal socket.

	 func RegisterServer(s Server, ref string) int64
		RegisterServer registers the given server s in channelz database. It returns
		the unique channelz tracking id assigned to this server.

	 func RegisterSubChannel(c Channel, pid int64, ref string) int64
		RegisterSubChannel registers the given channel c in channelz database with ref
		as its reference name, and add it to the child list of its parent (identified
		by pid). It returns the unique channelz tracking id assigned to this subchannel.

	 func RemoveEntry(id int64)
		RemoveEntry removes an entry with unique channelz trakcing id to be id from
		channelz database.

	 func ResetMaxTraceEntryToDefault()
		ResetMaxTraceEntryToDefault resets the maximum number of trace entry per entity to default.

	 func SetMaxTraceEntry(i int32)
		SetMaxTraceEntry sets maximum number of trace entry per entity (i.e. channel/subchannel).
		Setting it to 0 will disable channel tracing.

	 func TurnOn()
		TurnOn turns on channelz data collection.

	 func Warning(l grpclog.DepthLoggerV2, id int64, args ...interface{})
		Warning logs and adds a trace event if channelz is on.

	 func Warningf(l grpclog.DepthLoggerV2, id int64, format string, args ...interface{})
		Warningf logs and adds a trace event if channelz is on.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func copyMap(m map[int64]string) map[int64]string
	 func getMaxTraceEntry() int
	 func min(a, b int64) int64
Package-Level Variables (total 7, in which 1 are exported)

	  var EntryPerPage int64
		EntryPerPage defines the number of channelz entries to be shown on a web page.

	/* 6 unexporteds ... *//* 6 unexporteds: */
	  var curState int32
	  var db dbWrapper
	  var idGen idGenerator
	  var logger grpclog.DepthLoggerV2
	  var maxTraceEntry int32
	  var once sync.Once
Package-Level Constants (total 7, in which 6 are exported)

	const CtError Severity = 3
		CtError indicates error level severity of a trace event.

	const CtINFO Severity = 1
		CtINFO indicates info level severity of a trace event.

	const CtUNKNOWN Severity = 0
		CtUNKNOWN indicates unknown severity of a trace event.

	const CtWarning Severity = 2
		CtWarning indicates warning level severity of a trace event.

	const RefChannel RefChannelType = 0
		RefChannel indicates the referenced entity is a Channel.

	const RefSubChannel RefChannelType = 1
		RefSubChannel indicates the referenced entity is a SubChannel.

	/* one unexported ... *//* one unexported: */
	const defaultMaxTraceEntry int32 = 30

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin 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 @Go100and1 (reachable from the left QR code) to get the latest news of Golds.