grpc_channelz.v1.channelz Namespace Reference

Functions
def	add_channelz_servicer (server)

Variables
list	__all__
	__doc__
string	_add_channelz_servicer_doc

Function Documentation

add_channelz_servicer()

def grpc_channelz.v1.channelz.add_channelz_servicer

(

server

)

Definition at line 45 of file channelz.py.

Variable Documentation

__all__

list grpc_channelz.v1.channelz.__all__

private

Initial value:

=  [
        "aio",
        "add_channelz_servicer",
        "ChannelzServicer",
    ]

Definition at line 56 of file channelz.py.

__doc__

grpc_channelz.v1.channelz.__doc__

private

Definition at line 54 of file channelz.py.

_add_channelz_servicer_doc

string grpc_channelz.v1.channelz._add_channelz_servicer_doc

private

Initial value:

=  """Add Channelz servicer to a server.
 
Channelz servicer is in charge of
pulling information from C-Core for entire process. It will allow the
server to response to Channelz queries.
 
The Channelz statistic is enabled by default inside C-Core. Whether the
statistic is enabled or not is isolated from adding Channelz servicer.
That means you can query Channelz info with a Channelz-disabled channel,
and you can add Channelz servicer to a Channelz-disabled server.
 
The Channelz statistic can be enabled or disabled by channel option
'grpc.enable_channelz'. Set to 1 to enable, set to 0 to disable.
 
This is an EXPERIMENTAL API.
 
Args:
    server: A gRPC server to which Channelz service will be added.
"""

Definition at line 22 of file channelz.py.