admin
packageThis package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version
Modules with tagged versions give importers more predictable builds.
Stable version
When a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Documentation¶
Overview¶
Package admin provides a convenient method for registering a collection ofadministration services to a gRPC server. The services registered are:
- Channelz:https://github.com/grpc/proposal/blob/master/A14-channelz.md
- CSDS:https://github.com/grpc/proposal/blob/master/A40-csds-support.md
Experimental¶
Notice: All APIs in this package are experimental and may be removed in alater release.
Index¶
Constants¶
This section is empty.
Variables¶
This section is empty.
Functions¶
funcRegister¶
func Register(sgrpc.ServiceRegistrar) (cleanup func(), _error)
Register registers the set of admin services to the given server.
The returned cleanup function should be called to clean up the resourcesallocated for the service handlers after the server is stopped.
Note that if `s` is not a *grpc.Server or a *xds.GRPCServer, CSDS will not beregistered because CSDS generated code is old and doesn't support interface`grpc.ServiceRegistrar`.https://github.com/envoyproxy/go-control-plane/issues/403
Types¶
This section is empty.