xref: /aosp_15_r20/external/grpc-grpc/src/python/grpcio_admin/README.rst (revision cc02d7e222339f7a4f6ba5f422e6413f4bd931f2)
1*cc02d7e2SAndroid Build Coastguard WorkergRPC Python Admin Interface Package
2*cc02d7e2SAndroid Build Coastguard Worker===================================
3*cc02d7e2SAndroid Build Coastguard Worker
4*cc02d7e2SAndroid Build Coastguard WorkerDebugging gRPC library can be a complex task. There are many configurations and
5*cc02d7e2SAndroid Build Coastguard Workerinternal states, which will affect the behavior of the library. This Python
6*cc02d7e2SAndroid Build Coastguard Workerpackage will be the collection of admin services that are exposing debug
7*cc02d7e2SAndroid Build Coastguard Workerinformation. Currently, it includes:
8*cc02d7e2SAndroid Build Coastguard Worker
9*cc02d7e2SAndroid Build Coastguard Worker* Channel tracing metrics (grpcio-channelz)
10*cc02d7e2SAndroid Build Coastguard Worker* Client Status Discovery Service (grpcio-csds)
11*cc02d7e2SAndroid Build Coastguard Worker
12*cc02d7e2SAndroid Build Coastguard WorkerHere is a snippet to create an admin server on "localhost:50051":
13*cc02d7e2SAndroid Build Coastguard Worker
14*cc02d7e2SAndroid Build Coastguard Worker    server = grpc.server(ThreadPoolExecutor())
15*cc02d7e2SAndroid Build Coastguard Worker    port = server.add_insecure_port('localhost:50051')
16*cc02d7e2SAndroid Build Coastguard Worker    grpc_admin.add_admin_servicers(self._server)
17*cc02d7e2SAndroid Build Coastguard Worker    server.start()
18*cc02d7e2SAndroid Build Coastguard Worker
19*cc02d7e2SAndroid Build Coastguard WorkerWelcome to explore the admin services with CLI tool "grpcdebug":
20*cc02d7e2SAndroid Build Coastguard Workerhttps://github.com/grpc-ecosystem/grpcdebug.
21*cc02d7e2SAndroid Build Coastguard Worker
22*cc02d7e2SAndroid Build Coastguard WorkerFor any issues or suggestions, please send to
23*cc02d7e2SAndroid Build Coastguard Workerhttps://github.com/grpc/grpc/issues.
24