package
2.0.0+incompatible
Repository: https://github.com/csci-2390-project/grpc-go.git
Documentation: pkg.go.dev
# Functions
AddTraceEvent adds trace related to the entity with specified id, using the provided TraceEventDesc.
Error logs and adds a trace event if channelz is on.
Errorf logs and adds a trace event if channelz is on.
GetChannel returns the ChannelMetric for the channel (identified by id).
GetServer returns the ServerMetric for the server (identified by id).
GetServers returns a slice of server's ServerMetric, along with a boolean indicating whether there's more servers to be queried for.
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.
GetSocket returns the SocketInternalMetric for the socket (identified by id).
GetSocketOption gets the socket option info of the conn.
GetSubChannel returns the SubChannelMetric for the subchannel (identified by id).
GetTopChannels returns a slice of top channel's ChannelMetric, along with a boolean indicating whether there's more top channels to be queried for.
Info logs and adds a trace event if channelz is on.
Infof logs and adds a trace event if channelz is on.
IsOn returns whether channelz data collection is on.
NewChannelzStorage initializes channelz data storage and id generator.
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).
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).
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).
RegisterServer registers the given server s in channelz database.
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).
RemoveEntry removes an entry with unique channelz trakcing id to be id from channelz database.
ResetMaxTraceEntryToDefault resets the maximum number of trace entry per entity to default.
SetMaxTraceEntry sets maximum number of trace entry per entity (i.e.
TurnOn turns on channelz data collection.
Warning logs and adds a trace event if channelz is on.
Warningf logs and adds a trace event if channelz is on.
# Constants
CtError indicates error level severity of a trace event.
CtInfo indicates info level severity of a trace event.
CtUnknown indicates unknown severity of a trace event.
CtWarning indicates warning level severity of a trace event.
RefChannel indicates the referenced entity is a Channel.
RefSubChannel indicates the referenced entity is a SubChannel.
# Variables
EntryPerPage defines the number of channelz entries to be shown on a web page.
# Structs
ChannelInternalMetric defines the struct that the implementor of Channel interface should return from ChannelzMetric().
ChannelMetric defines the info channelz provides for a specific Channel, which includes ChannelInternalMetric and channelz-specific data, such as channelz id, child list, etc.
ChannelTrace stores traced events on a channel/subchannel and related info.
ServerInternalMetric defines the struct that the implementor of Server interface should return from ChannelzMetric().
ServerMetric defines the info channelz provides for a specific Server, which includes ServerInternalMetric and channelz-specific data, such as channelz id, child list, etc.
SocketInternalMetric defines the struct that the implementor of Socket interface should return from ChannelzMetric().
SocketMetric defines the info channelz provides for a specific Socket, which includes SocketInternalMetric and channelz-specific data, such as channelz id, etc.
SocketOptionData defines the struct to hold socket option data, and related getter function to obtain info from fd.
SubChannelMetric defines the info channelz provides for a specific SubChannel, which includes ChannelInternalMetric and channelz-specific data, such as channelz id, child list, etc.
TraceEvent represent a single trace event.
TraceEventDesc is what the caller of AddTraceEvent should provide to describe the event to be added to the channel trace.
# Interfaces
Channel is the interface that should be satisfied in order to be tracked by channelz as Channel or SubChannel.
Server is the interface to be satisfied in order to be tracked by channelz as Server.
Socket is the interface that should be satisfied in order to be tracked by channelz as Socket.
# Type aliases
RefChannelType is the type of the entity being referenced in a trace event.
Severity is the severity level of a trace event.