Detailed Instructions and Effects for Each Command on Apache Dubbo

Basic Command Manual

Mon, 01 Jan 0001 00:00:00 +0000

The basic command functionality provides a set of fundamental commands.

help command

Display more commands

// List all commands
dubbo>help

// List specific usage of a single command
dubbo>help online
+--------------+----------------------------------------------------------------------------------+
| COMMAND NAME | online |
+--------------+----------------------------------------------------------------------------------+
| EXAMPLE | online dubbo |
| | online xx.xx.xxx.service |
+--------------+----------------------------------------------------------------------------------+

dubbo>

version command

Display the version number of the currently running Dubbo

dubbo>version
dubbo version "3.0.10-SNAPSHOT"

dubbo>

quit command

Exit the command state

Service Management Commands

Mon, 01 Jan 0001 00:00:00 +0000

The service management feature provides a series of commands to manage Dubbo services.

Service Management

ls Command

List Consumers and Providers

dubbo>ls
As Provider side:
+------------------------------------------------------------------------+---------------------+
| Provider Service Name | PUB |
+------------------------------------------------------------------------+---------------------+
|DubboInternal - UserRead/org.apache.dubbo.metadata.MetadataService:1.0.0| |
+------------------------------------------------------------------------+---------------------+
| com.dubbo.dubbointegration.UserReadService |nacos-A(Y)/nacos-I(Y)|
+------------------------------------------------------------------------+---------------------+
As Consumer side:
+-----------------------------------------+-----------------+
| Consumer Service Name | NUM |
+-----------------------------------------+-----------------+
|com.dubbo.dubbointegration.BackendService|nacos-AF(I-2,A-2)|
+-----------------------------------------+-----------------+

This command lists the services provided and consumed by Dubbo, as well as the number of addresses for the consumed services.

Framework status commands

Mon, 01 Jan 0001 00:00:00 +0000

startup command

Check whether the current framework has started completely

dubbo>startup
true

dubbo>

ready command

Check whether the current framework can provide services normally (it may be temporarily offline)

dubbo>ready
true

dubbo>

live command

Check whether the current framework is running normally (it may be permanently abnormal)

dubbo>live
true

dubbo>

Runtime Management of the Logging Framework

Mon, 01 Jan 0001 00:00:00 +0000

Note

Starting from 3.0.10, dubbo-qos runtime control supports querying logging configurations and dynamically modifying the logging framework and log levels used.

The logging configurations modified through dubbo-qos are not persistently stored and will be ineffective after application restarts.

Query Logging Configuration

Command: loggerInfo

Example:

> telnet 127.0.0.1 22222
> loggerInfo

Output:

Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
 ___ __ __ ___ ___ ____ 
 / _ \ / / / // _ ) / _ ) / __ \ 
 / // // /_/ // _ |/ _ |/ /_/ / 
/____/ \____//____//____/ \____/ 
dubbo>loggerInfo
Available logger adapters: [jcl, jdk, log4j, slf4j]. Current Adapter: [log4j]. Log level: INFO

Change Log Level

Command: switchLogLevel {level}

Performance Sampling Command

Mon, 01 Jan 0001 00:00:00 +0000

The performance sampling feature can detect the time consumption at various points in the Dubbo processing chain. When a timeout occurs ( usageTime / timeout > profilerWarnPercent * 100 ), the call duration is logged.

This feature is divided into two modes: simple profiler and detail profiler. The simple profiler mode is enabled by default, while the detail profiler mode is disabled by default. The detail profiler collects additional information such as processing time for each filter and specific time consumption on protocols, compared to the simple profiler. If long processing times are found within the Dubbo framework while in simple profiler, the detail profiler can be enabled for better issue diagnosis.

Router Status Command

Mon, 01 Jan 0001 00:00:00 +0000

Many traffic governance capabilities in Dubbo are implemented based on the Router. In production environments, if traffic results do not meet expectations, you can use the router status command to check the router’s status to locate potential issues.

Router Status Collection

getRouterSnapshot Command

Retrieve the grouping status of each layer of the router. (Only supports StateRouter)

Command: getRouterSnapshot {serviceName}

serviceName is the name of the service to collect, supports matching.

Serialization Security Audit

Mon, 01 Jan 0001 00:00:00 +0000

Dubbo supports real-time viewing of current configuration information and the list of trusted/untrusted classes through QoS commands. Currently, two commands are supported: serializeCheckStatus to view current configuration information, and serializeWarnedClasses to view the real-time warning list.

`serializeCheckStatus` Command

Access directly through the console:

> telnet 127.0.0.1 22222
Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
 ___ __ __ ___ ___ ____ 
 / _ \ / / / // _ ) / _ ) / __ \  
 / // // /_/ // _ |/ _ |/ /_/ / 
/____/ \____//____//____/ \____/ 
dubbo>serializeCheckStatus
CheckStatus: WARN

CheckSerializable: true

AllowedPrefix:
...

DisAllowedPrefix:
...


dubbo>

By HTTP request for JSON format results:

Default Monitoring Metrics Command

Mon, 01 Jan 0001 00:00:00 +0000

Query All Monitoring Metrics

Command: metrics_default

Example:

> telnet 127.0.0.1 22222
> metrics_default

Output:

Trying 127.0.0.1...
Connected to localhost.
Escape character is '^]'.
 ___ __ __ ___ ___ ____ 
 / _ \ / / / // _ ) / _ ) / __ \ 
 / // // /_/ // _ |/ _ |/ /_/ / 
/____/ \____//____//____/ \____/ 
dubbo>metrics_default
dubbo.registry.directory.num.disable.total{application.module.id=1.1,application.name=dubbo-springboot-demo-provider,application.version=,git.commit.id=,hostname=hujundeMacBook-Pro.local,interface=dubbo-springboot-demo-provider/org.apache.dubbo.metrics.service.MetricsService:1.0.0,ip=10.224.214.80,} 0.0
dubbo.register.rt.milliseconds.max{application.module.id=1.1,application.name=dubbo-springboot-demo-provider,application.version=,git.commit.id=,hostname=hujundeMacBook-Pro.local,ip=10.224.214.80,} 153.0

Query Monitoring Metrics by Keyword

Command: metrics_default {applicationName} {keyword}

Detailed Instructions and Effects for Each Command on Apache Dubbo

Basic Command Manual

help command

version command

quit command

Service Management Commands

Service Management

ls Command

Framework status commands

startup command

ready command

live command

Runtime Management of the Logging Framework

Note

Query Logging Configuration

Change Log Level

Performance Sampling Command

Router Status Command

getRouterSnapshot Command

Serialization Security Audit

serializeCheckStatus Command

Default Monitoring Metrics Command

Query All Monitoring Metrics

Query Monitoring Metrics by Keyword

`serializeCheckStatus` Command