QoS Command List, Command Reference

List of QoS commands, command reference.

QoS CommandDescriptionTelnet Usage ExampleHTTP Usage Example
cdSet service context, all subsequent commands will target this servicecd org.demo.DemoServicehttp://localhost:22222/cd?service=org.demo.DemoService
countShow service or method call count. Currently only supports dubbo protocol, does not support triple protocol; RpcStatus implementation depends on Active/Limit Filtercount org.demo.DemoService

count org.demo.DemoService methodName		http://localhost:22222/count?service=org.demo.DemoService&method=methodName
disableDetailProfilerDisable RPC call profiler tool (fine-grained version)disableDetailProfilerhttp://localhost:22222/disableDetailProfiler
disableRouterSnapshotDisable RPC request Router routing result trackingdisableRouterSnapshothttp://localhost:22222/disableRouterSnapshot
disableSimpleProfilerDisable RPC call profiler tool (coarse-grained version)disableSimpleProfilerhttp://localhost:22222/disableSimpleProfiler
enableDetailProfilerEnable RPC call profiler tool (fine-grained version)enableDetailProfilerhttp://localhost:22222/enableDetailProfiler
enableRouterSnapshotEnable RPC request Router routing result tracking, helpful for tracking if routing rules execution meets expectationsenableRouterSnapshot org.demo.DemoServicehttp://localhost:22222/enableRouterSnapshot?service=org.demo.DemoService
enableSimpleProfilerEnable RPC call profiler tool (coarse-grained version)enableSimpleProfilerhttp://localhost:22222/enableSimpleProfiler
getAddressView the effective IP address list of a servicegetAddress org.demo.DemoServicehttp://localhost:22222/getAddress?service=org.demo.DemoService
getConfigDump the effective configuration of the current applicationgetConfighttp://localhost:22222/getConfig
getEnabledRouterSnapshotView the list of services with “Enabled Router routing result tracking”getEnabledRouterSnapshothttp://localhost:22222/getEnabledRouterSnapshot
getRecentRouterSnapshotView the most recent 32 “Router routing result tracking” datagetRecentRouterSnapshothttp://localhost:22222/getRecentRouterSnapshot
gracefulShutdownOffline all services registered with the current IP instance from the registry; different from offline, this command will also inform all consumers to stop calling this instance through TCP connection.

To restore, please execute online to put all services back online		gracefulShutdownhttp://localhost:22222/gracefulShutdown
helpHelp commandhelphttp://localhost:22222/help
invokeCall a specific RPC serviceinvoke org.demo.DemoService.methodName(1234, “abcd”, {“prop”:“value”})?
liveCheck if the current process/service is alive, can be configured as Kubernetes livenesslivehttp://localhost:22222/live
loggerInfoView current log logger configurationloggerInfohttp://localhost:22222/loggerInfo
lsView the current list of all serviceslshttp://localhost:22222/ls
metricsView metrics indicators; metrics statistics must be enabled to see data. What granularity?metricshttp://localhost:22222/metrics
metrics_defaultView metrics indicators; metrics statistics must be enabled to see data. What granularity?metrics_defaulthttp://localhost:22222/metrics_default
offlineTake one or more services offline from the registry (including application-level and interface-level addresses)offline

offline org.demo.DemoService		http://localhost:22222/offline

http://localhost:22222/offline?service=org.demo.DemoService
offlineAppTake one or more application-level services offline from the registryofflineApp

offlineApp org.demo.DemoService		http://localhost:22222/offlineApp?service=org.demo.DemoService
offlineInterfaceTake one or more interface-level services offline from the registryofflineInterface

offlineInterface org.demo.DemoService		http://localhost:22222/offlineInterface?service=org.demo.DemoService
onlineRegister one or more services to the registry (including application-level and interface-level addresses)online

online org.demo.DemoService		http://localhost:22222/online?service=org.demo.DemoService
onlineAppRegister one or more application-level services to the registryonlineApp

onlineApp org.demo.DemoService		http://localhost:22222/onlineApp?service=org.demo.DemoService
onlineInterfaceRegister one or more interface-level services to the registryonlineInterface

onlineInterface org.demo.DemoService		http://localhost:22222/onlineInterface?service=org.demo.DemoService
psView current process information, including listening ports, etc.pshttp://localhost:22222/ps
publishMetadataPublish or update current application Metadata data (can be used for manual updates of application-level service discovery metadata). publishMetadata 10 means delay of 10s for publishing. In versions before 3.3.0, the command was publish-metadatapublishMetadata

publishMetadata 10		http://localhost:22222/publishMetadata
pwdView the current service context, used with cdpwdhttp://localhost:22222/pwd
quitExit the current telnet commandquitNone
readyCheck if the current process/service is ready for external service, can be configured as Kubernetes readinessreadyhttp://localhost:22222/ready
selectCall method? What is the relationship with invoke??http://localhost:22222/?
serializeCheckStatusCheck the list of classes currently in the serialization whitelistserializeCheckStatushttp://localhost:22222/serializeCheckStatus
serializeWarnedClassesCheck the list of classes currently in the serialization warning listserializeWarnedClasseshttp://localhost:22222/serializeWarnedClasses
setProfilerWarnPercentControl serialization alarm frequency (only for classes in the warning list)setProfilerWarnPercent 0.75http://localhost:22222/setProfilerWarnPercent?k=0.75
shutdownTry to shut down the current Dubbo application (destroy all resources, cannot be recovered before restart)shutdownhttp://localhost:22222/shutdown
startupCheck if the current process/service has started normally, can be configured as Kubernetes startupstartuphttp://localhost:22222/startup
switchLogLevelDynamically adjust log levelswitchLogLevel debughttp://localhost:22222/switchLogLevel?k=debug
switchLoggerSwitch log logger component. Available logger components can be viewed through loggerInfo (please ensure the application has joined the relevant component dependencies before switching)switchLogger log4j2http://localhost:22222/switchLogger?k=log4j2
versionView the current Dubbo framework version in useversionhttp://localhost:22222/version

Feedback

Was this page helpful?

Yes No

Last modified September 30, 2024: Update & Translate Overview Docs (#3040) (d37ebceaea7)