Apache SkyWalking CLI

Clone this repo:
  1. 98f1a92 Implement auto-refresh for `dashboard` (#63) by Hoshea Jiang · 8 days ago master
  2. 1cd33be Fix standard time (#62) by Hoshea Jiang · 3 weeks ago
  3. 8d67d80 Update code style (#61) by huawei · 3 weeks ago
  4. 1ccc486 Update traces search (#60) by huawei · 4 weeks ago
  5. b47c5fb Refactor `metrics thermodynamic` command (#59) by Hoshea Jiang · 4 weeks ago

Apache SkyWalking CLI

The CLI (Command Line Interface) for Apache SkyWalking.

SkyWalking CLI is a command interaction tool for the SkyWalking user or OPS team, as an alternative besides using browser GUI. It is based on SkyWalking GraphQL query protocol, same as GUI.

Download

Go to the download page to download all available binaries, including MacOS, Linux, Windows. If you want to try the latest features, however, you can compile the latest codes yourself, as the guide below.

Install

As SkyWalking CLI is using Makefile, compiling the project is as easy as executing a command in the root directory of the project.

git clone https://github.com/apache/skywalking-cli
cd skywalking-cli
git submodule init
git submodule update
make

and copy the ./bin/swctl-latest-(darwin|linux|windows)-amd64 to your PATH directory according to your OS, usually /usr/bin/ or /usr/local/bin, or you can copy it to any directory you like, and add that directory to PATH, we recommend you to rename the swctl-latest-(darwin|linux|windows)-amd64 to swctl.

Commands

Commands in SkyWalking CLI are organized into two levels, in the form of swctl --option <level1> --option <level2> --option, there're options in each level, which should follow right after the corresponding command, take the following command as example:

$ swctl --debug service list --start="2019-11-11" --end="2019-11-12"

where --debug is is an option of swctl, and since the swctl is a top-level command, --debug is also called global option, and --start is an option of the third level command list, there is no option for the second level command service.

Generally, the second level commands are entity related, there're entities like service, service instance, metrics in SkyWalking, and we have corresponding sub-command like service; the third level commands are operations on the entities, such as list command will list all the services, service instances, etc.

Common options

There're some common options that are shared by multiple commands, and they follow the same rules in different commands,

--start and --end specify a time range during which the query is preformed, they are both optional and their default values follow the rules below:

  • when start and end are both absent, start = now - 30 minutes and end = now, namely past 30 minutes;
  • when start and end are both present, they are aligned to the same precision by truncating the more precise one, e.g. if start = 2019-01-01 1234, end = 2019-01-01 18, then start is truncated (because it's more precise) to 2019-01-01 12, and end = 2019-01-01 18;
  • when start is absent and end is present, will determine the precision of end and then use the precision to calculate start (minus 30 units), e.g. end = 2019-11-09 1234, the precision is MINUTE, so start = end - 30 minutes = 2019-11-09 1204, and if end = 2019-11-09 12, the precision is HOUR, so start = end - 30HOUR = 2019-11-08 06;
  • when start is present and end is absent, will determine the precision of start and then use the precision to calculate end (plus 30 units), e.g. start = 2019-11-09 1204, the precision is MINUTE, so end = start + 30 minutes = 2019-11-09 1234, and if start = 2019-11-08 06, the precision is HOUR, so end = start + 30HOUR = 2019-11-09 12;

--timezone specifies the timezone where --start --end are based, in the form of +0800:

  • if --timezone is given in the command line option, then it's used directly;
  • else if the backend support the timezone API (since 6.5.0), CLI will try to get the timezone from backend, and use it;
  • otherwise, the CLI will use the current timezone in the current machine;

All available commands

This section covers all the available commands in SkyWalking CLI and their usages.

swctl

swctl is the top-level command, which has some options that will take effects globally.

optiondescriptiondefault
--configfrom where the default options values will be loaded~/.skywalking.yml
--debugenable debug mode, will print more detailed information at runtimefalse
--base-urlbase url of GraphQL backendhttp://127.0.0.1:12800/graphql
--displaydisplay style when printing the query result, supported styles are: json, yaml, table, graphjson

Note that not all display styles (except for json and yaml) are supported in all commands due to data formats incompatibilities and the limits of Ascii Graph, like coloring in terminal, so please use json or yaml instead.

service

service list lists all the services in the time range of [start, end].

optiondescriptiondefault
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options

instance

instance list lists all the instances in the time range of [start, end] and given --service-id or --service-name.

optiondescriptiondefault
--service-idQuery by service id (priority over --service-name)
--service-nameQuery by service name if --service-id is absent
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options

instance search filter the instance in the time range of [start, end] and given --regex --service-id or --service-name.

optiondescriptiondefault
--regexQuery regex of instance name
--service-idQuery by service id (priority over --service-name)
--service-nameQuery by service name if service-id is absent
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options

endpoint

endpoint list lists all the endpoints of the given service id in the time range of [start, end].

optiondescriptiondefault
--service-id whose endpoints are to be searched
--limitreturns at most endpoints (default: 100)100
--keyword of the endpoint name to search for, empty to search all""

metrics

metrics linear

optiondescriptiondefault
--nameMetrics name, defined in OAL, such as all_p99, etc.
--idthe related id if the metrics requires one, e.g. for metrics service_p99, the service id is required, use --id to specify the service id, the same for instance, endpoint, etc.
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options

metrics multiple-linear

optiondescriptiondefault
--nameMetrics name, defined in OAL, such as all_p99, etc.
--idthe related id if the metrics requires one, e.g. for metrics service_p99, the service id is required, use --id to specify the service id, the same for instance, endpoint, etc.
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options
--numNumber of the linear metrics to fetch5

metrics single

optiondescriptiondefault
--nameMetrics name, defined in OAL, such as service_sla, etc.
--idsIDs that are required by the metric type, such as service IDs for service_sla
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options

metrics top <n>

optiondescriptiondefault
--nameMetrics name, defined in OAL, such as service_sla, etc.
--service-idservice ID that are required by the metric type, such as service IDs for service_sla
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options
argumentsthe first argument is the number of top entities3

metrics thermodynamic

optiondescriptiondefault
--nameMetrics name, defined in OAL, such as service_sla, etc.
--scopeThe scope of metrics, which is consistent with --name, such as All, Service, etc.All
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options

instance search filter the instance in the time range of [start, end] and given --regex --service-id or --service-name.

optiondescriptiondefault
--regexQuery regex of instance name
--service-idQuery by service id (priority over --service-name)
--service-nameQuery by service name if service-id is absent
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options

trace

trace displays the spans of a given trace.

argumentdescriptiondefault
trace idThe trace id whose spans are to displayed

trace ls

argumentdescriptiondefault
--trace-idThe trace id whose spans are to displayed
--service-idThe service id whose trace are to displayed
--service-instance-idThe service instance id whose trace are to displayed
--tagsOnly tags defined in the core/default/searchableTagKeys are searchable. Check more details on the Configuration Vocabulary pageSee Configuration Vocabulary page
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options

dashboard

dashboard global-metrics

dashboard global-metrics displays global metrics in the form of a dashboard.

argumentdescriptiondefault
--templateThe template file to customize how to display informationtemplates/Dashboard.Global.json
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options

You can imitate the content of the default template file to customize the dashboard.

dashboard global

dashboard global displays global metrics, global response latency and global heat map in the form of a dashboard.

argumentdescriptiondefault
--templateThe template file to customize how to display informationtemplates/Dashboard.Global.json
--refreshThe interval of auto-refresh (s). When start and end are both present, auto-refresh is disabled.6
--startSee Common optionsSee Common options
--endSee Common optionsSee Common options

checkHealth

argumentdescriptiondefault
--grpcEnable/Disable check gRPC endpointtrue
--grpcAddrThe address of gRPC endpoint127.0.0.1:11800
--grpcTLSEnable/Disable TLS to access gRPC endpointfalse

*Notice: Once enable gRPC TLS, checkHealth command would ignore server's cert.

Use Cases

# query the service named projectC
$ ./bin/swctl service ls projectC
[{"id":"4","name":"projectC"}]

If you have already got the id of the service:

$ ./bin/swctl instance ls --service-id=3
[{"id":"3","name":"projectD-pid:7909@skywalking-server-0001","attributes":[{"name":"os_name","value":"Linux"},{"name":"host_name","value":"skywalking-server-0001"},{"name":"process_no","value":"7909"},{"name":"ipv4s","value":"192.168.252.12"}],"language":"JAVA","instanceUUID":"ec8a79d7cb58447c978ee85846f6699a"}]

otherwise,

$ ./bin/swctl instance ls --service-name=projectC
[{"id":"3","name":"projectD-pid:7909@skywalking-server-0001","attributes":[{"name":"os_name","value":"Linux"},{"name":"host_name","value":"skywalking-server-0001"},{"name":"process_no","value":"7909"},{"name":"ipv4s","value":"192.168.252.12"}],"language":"JAVA","instanceUUID":"ec8a79d7cb58447c978ee85846f6699a"}]

If you have already got the id of the service:

$ ./bin/swctl endpoint ls --service-id=3

otherwise,

./bin/swctl service ls projectC | jq '.[].id' | xargs ./bin/swctl endpoint ls --service-id 
[{"id":"22","name":"/projectC/{value}"}]

If you have already got the id of the instance:

$ ./bin/swctl --display=graph metrics linear --name=service_instance_resp_time --id 5
┌─────────────────────────────────────────────────────────────────────────────────Press q to quit──────────────────────────────────────────────────────────────────────────────────┐
                                                                                                                                                                                  
                                                                                                                                                                                  
                                                                                                                                                             ⡜⠢⡀                 
  1181.80                                      ⡰⡀                                                         ⢀⡠⢢         ⡰⢣                                    ⡰⠁ ⠈⠢⡀               
                                              ⢠⠃⠱⡀                                                     ⢀⠔⠁  ⠱⡀     ⢀⠜                          ⢀⠞⡄       ⢠⠃    ⠈⠢⡀             
                                                ⠱⡀          ⢀⠔⠊⠱⡀                 ⢀⣀⣀⣀              ⢀⡠⠊⠁     ⠘⢄   ⢀⠎                          ⡠⠃ ⠘⡄             ⠈⠑⠢⢄⡀  ⢀⡠⠔⠊⠁  
                   ⢀⠤⣀⡀       ⢀⡀                         ⡠⠔⠁   ⠱⡀            ⡠⠊⠉⠉⠁   ⠉⠉⠒⠒⠤⠤⣀⣀⣀ ⢀⡠⠔⠊⠁          ⠣⡀⡠⠃                 ⢀⠔⠤⡀     ⡰⠁   ⠘⡄                ⠈⠑⠊⠁      
  1043.41│⡀       ⢀⠔⠁  ⠈⠑⠒⠤⠔⠒⠊⠉⠁⠈⠒⢄          ⢀⠇         ⢀⠤⠊       ⠱⡀         ⢀⠔⠁                ⠉⠁               ⠑⠁                 ⡠⠃  ⠈⠒⢄ ⢀⠜      ⠘⡄  ⢰⠁                      
         │⠈⠑⠤⣀   ⡠⠊                ⠑⠤⡀               ⣀⠔⠁          ⠱⡀       ⡰⠁                                              ⠣⢄⣀    ⢠⠊       ⠉⠊        ⠘⡄⢠⠃                       
             ⠑⠢⠊                    ⠈⠢⡀    ⢰⠁                      ⠱⡀  ⣀⠤⠔⠊                                                   ⠉⠒⠢⠔⠁                   ⠘⠎                        
                                      ⠈⠢⡀ ⢀⠇                         ⠑⠊⠉                                                                                                         
      905                               ⠈⠢⡜                                                                                                                                      
         └──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────  
          2019-12-02 2121   2019-12-02 2107   2019-12-02 2115   2019-12-02 2119   2019-12-02 2137   2019-12-02 2126   2019-12-02 2118   2019-12-02 2128   2019-12-02 2136         
                                                                                                                                                                                  
                                                                                                                                                                                  
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

otherwise

$ ./bin/swctl instance ls --service-name=projectC | jq '.[] | select(.name == "projectC-pid:7895@skywalking-server-0001").id' | xargs ./bin/swctl --display=graph metrics linear --name=service_instance_resp_time --id
┌─────────────────────────────────────────────────────────────────────────────────Press q to quit──────────────────────────────────────────────────────────────────────────────────┐
                                                                                                                                                                                  
                                                                                                                                                                                  
                                                                                    ⡠⠒⢣                                                                                          
  1181.80                          ⡠⠊⢢                                           ⣀⠔⠉                 ⡔⡄                               ⡔⡄                                        
                                ⡠⠊   ⠑⡄                                    ⣀⡠⠔⠒⠉                    ⠈⢆                            ⢀⠎ ⠈⢢                                      
                    ⠉⠒⠤⣀   ⢀⣀⣀⡠⠊      ⠈⠢⡀               ⢀⡠⢄⣀⡀            ⡰⠉                                                     ⡠⠃    ⠑⡄        ⢀⡠⠔⠉⠘⢄                       
                 ⢀⠜      ⠉⠉⠉⠁            ⠑⢄          ⢀⡠⠔⠊⠁   ⠈⠉⠑⢢        ⡰⠁                      ⢀⠎      ⠱⡀          ⢀⠦⡀         ⢀⠜       ⠈⢢ ⢀⣀⣀⡠⠤⠒⠁     ⠣⡀                    
  1043.41       ⢀⠎                         ⠑⢄      ⢀⠔⠁           ⠱⡀     ⡰⠁                 ⢣⣀    ⢀⠎        ⠘⢄        ⢀⠎ ⠈⢢      ⢀⠤⠊          ⠉⠁            ⠘⢄               ⡠⠊   
               ⢠⠃                           ⠈⠢⡀  ⡠⠒⠁              ⠘⢄   ⡰⠁                    ⠉⠉⠉⠒⠊          ⠈⢢      ⢀⠎    ⠑⢄  ⡠⠒⠁                            ⠣⠤⣀⣀⣀       ⢀⠔⠉     
         │⠤⠤⠤⠤⠤⠤⠃                              ⠈⠢⠊                   ⠣⡀⡰⠁                                      ⠱⡀   ⢀⠎       ⠑⠉                                    ⠉⠉⠉⠉⠒⠒⠒⠁       
                                                                     ⠑⠁                                        ⠑⡄ ⢀⠎                                                             
      905                                                                                                       ⠈⢆⠎                                                              
         └──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────  
          2019-12-02 2122   2019-12-02 2137   2019-12-02 2136   2019-12-02 2128   2019-12-02 2108   2019-12-02 2130   2019-12-02 2129   2019-12-02 2115   2019-12-02 2119         
                                                                                                                                                                                  
                                                                                                                                                                                  
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
$ ./bin/swctl service ls projectC | jq '.[0].id' | xargs ./bin/swctl endpoint ls --service-id | jq '.[] | [.id] | join(",")' | xargs ./bin/swctl metrics single --name endpoint_cpm --ids
[{"id":"22","value":116}]
$ ./bin/swctl service ls projectC | jq '.[0].id' | xargs ./bin/swctl endpoint ls --service-id | jq '.[] | [.id] | join(",")' | xargs ./bin/swctl metrics single --name endpoint_cpm --end='2019-12-02 2137' --ids
[{"id":"3","value":116}]
$ ./bin/swctl --display=graph --debug metrics multiple-linear --name all_percentile

PRESS Q TO QUIT───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┐
│┌───────────────────────────────#0───────────────────────────────┐┌───────────────────────────────#1───────────────────────────────┐┌─────────────────────────────────#2─────────────────────────────────┐│
││        ⡏⠉⠉⢹   ⢸⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⡇      ⢸⠉⠉⠉⠉⠉⠉⠉⡇  ⢸⠉⠉⠉⠉⠉⠉⠉⡇   ⡏⠉⠉⠉ ││            ⢸⡀                                              ││                                                          ⡠⠔⡇      ││
││960.80 ⢀⠇  ⠘⡄                                           ││1963.60     ⡜⡇                                      ⢠⡇       ││ 2600.40                                                         ││
││                                                      ││            ⡇⢸                       ⡼⡀              ⢸⢣       ││                                                                 ││
││                                                      ││            ⡇⠈⡆                      ⡇⡇       ⡇⡇      ⢸⢸       ││                                                                 ││
││            ⢠⠃            ⠘⡄                            ││           ⢰⠁                       ⡇⡇  ⡤⢤   ⡇⡇      ⡇⢸       ││                                                           ⠘⡄     ││
││824.64                                ⠈⡆        ⠘⡄      ││1832.88                            ⡇⡇  ⡇⢸   ⡇⡇      ⡇⢸       ││ 2486.33                                                         ││
││                                                      ││                                   ⡇⡇  ⠈⡆ ⢀⠇⡇     ⢠⠃⢸       ││                                                        ⢰⠁        ││
││           ⠈⡆⡎                           ⡇⢸               ││                                  ⢰⠁⡇           ⠘⡄      ││                                       ⢸⠉⠲⡀                    ││
││      │⢰⠁     ⡇⡇                           ⢇⢸               ││                                                     ││        │⡀                     ⢰⢱    ⢀⡄     ⢀⠎⡆              ⣀⠤ ││
││688.48│⢸      ⡇⡇                           ⢸⢸         ⢸⢸      ││1702.16                                              ││ 2372.24│⠱⡀       ⡴⡀         ⢠⠃⠈⡆  ⢀⠎⠸⡀⢠⠃   ⢣⠎       ⡠⠃     ⢰⠁  ││
││      │⢸      ⢱⠁              ⠘⡄            ⢸⢸         ⢸⢸      ││                                                     ││                ⠱⡀⡠⠋⡆     ⣀⠎   ⡠⠊  ⢣⢸        ⢇⡔⠁⢣ ⣀⠔⠁     ⠈⣦⠃   ││
││      │⡜                                  ⢸⡜         ⢸⢸      ││                          ⢀⡆      ⢸⢀⠇                 ││             ⡔⠊   ⠑⠁ ⠸⡀  ⢠⠋    ⠈⠖⠁   ⠈⠇                        ││
││      │⡇                                   ⠈⡇         ⠘⡜      ││                    ⢠⢣  ⢰⢄ ⡜⢸      ⢸⢸         ⢠⠃        ││                     ⢣⡀                                         ││
││552.32│⠁                       ⠸⡀                            ││1571.44             ⢸⢸    ⠘⡄     ⠘⣼    ⡇⡇              ││ 2258.16              ⠈⠙                                         ││
││                                                            ││         ⢀⠇          ⡜⢸                ⡇⡇              ││                                                                 ││
││                                                             ││       │⢣      ⠸⡀                     ⣇⠇              ││          ⠈⡆                                                      ││
││                                                             ││       │⠈⢆⡸      ⡇⢀   ⢠⠃ ⡇⢀⠇    ⠈⡦⠔⢇⢀⠇                     ││                                                                 ││
││416.16                                                       ││1440.72 ⠘⡇      ⠋⠙⡄    ⢱⢸        ⠸⣸           ⠱⡀     ⠈⡆     ││2144.080                                                         ││
││                                ⠘⡄⡎                            ││                      ⢸⢸                      ⠱⡀⢠⠃         ││           ⢸⢸                                                      ││
││                                 ⡇⡇                            ││                   ⢰⠁  ⠸⡜                       ⠘⣼     ⠧⣀    ││           ⢸⢸                                                      ││
││                                 ⢸⡇                            ││                   ⡇⡎                                    ⠑⢄  ││           ⠘⡜                                                      ││
││   280                           ⠈⡇                            ││   1310            ⢱⠁                                          ││    2030                                                          ││
││      └─────────────────────────────────────────────────────────││       └────────────────────────────────────────────────────────││        └───────────────────────────────────────────────────────────││
││       2020-03-07 0111   2020-03-07 0134   2020-03-07 0133      ││        2020-03-07 0116   2020-03-07 0121   2020-03-07 0122     ││         2020-03-07 0123   2020-03-07 0139   2020-03-07 0117        ││
│└────────────────────────────────────────────────────────────────┘└────────────────────────────────────────────────────────────────┘└────────────────────────────────────────────────────────────────────┘│
│┌────────────────────────────────────────────────#3─────────────────────────────────────────────────┐┌────────────────────────────────────────────────#4─────────────────────────────────────────────────┐│
││                                                  ⢀⢇                                              ││        │⠤⠤⠤⠤⠤⠤⡄     ⡤⠤⢤        ⢸⠑⠒⠤⠤⠤⠤⠤⠤⠤⠤⠤⠤⠤⠤⠤⠒⠊⠉⠉⠉⠉⠉⠉⠉⠒⠢⡄     ⡤⠒⠊⡇       ⢠⠔⠒⢹           ⢠⠔⠒⠉⠑⠢⠄ ││
││                                                  ⡸⠸⡀               ⢀⡆                            ││                                                                                        ││
││3559.60                                          ⢀⠇               ⢀⠎⢸                            ││54073.20          ⢰⠁ ⠈⡆                                     ⢰⠁                             ││
││                  ⢀⢄                               ⠸⡀            ⢀⠎ ⠘⡄                           ││                                                                                        ││
││                 ⢀⠎ ⠑⢄                          ⢀⠇              ⢀⠎                             ││                                                                                        ││
││                ⢀⠎   ⠈⢆                            ⠸⡀ ⣀⡀                   ⡸⠸⡀                ││              ⠸⡀            ⢰⠁                          ⠸⡀      ⠈⡆                  ⢀⠇       ││
││3325.68   ⣀⣀  ⣀⠤⠊     ⠘⡄   ⢀⣀⣀⣀⣀⡠⠤⡀      ⢀⣀⠔⠊ ⠉⠑⠃     ⠉⠉ ⠘⢄     ⡰⠁    ⠘⡄      ⢰⠁        ⢀⣀⡠⠤⠤⠤⠄  ││43924.56                                                           ⢰⠁                    ││
││        ⢠⠊  ⠉⠉         ⠸⡀ ⡔⠁      ⠑⢄  ⡠⠊⠉⠁                 ⠣⣀  ⢠⠃           ⢠⠃      ⢀⠤⠊⠁        ││                                                                                        ││
││       │⠔⠁               ⠱⠊         ⠈⠢⠊                       ⠉⠒⠎       ⠸⠤⠤⠤⠔⠊⠁                  ││                                                                                        ││
││                                                                                                ││                 ⢰⠁   ⠈⡆                                                                  ││
││3091.76                                                                                         ││33775.92                                                                                ││
││                                                                                    ⢀⠇           ││                                                                                        ││
││                                                                                                ││               ⠸⡀          ⢰⠁                            ⠘⡄      ⠈⡆                ⢠⠃        ││
││                                                                                                ││                                                                  ⢠⠃                     ││
││2857.84                                                                                         ││23627.28                                                                                ││
││                                                                                                ││                                                        ⢇⢀⠇                               ││
││                                                                                   ⢀⠇            ││                ⢱⢰⠁     ⠈⡆                                 ⢸⢸                                ││
││                                                                                                ││                ⢸⢸                                        ⢸⢸                                ││
││2623.92                                                                           ⠈⡆⢸             ││13478.64        ⢸⢸                                        ⢸⢸                                ││
││                                                                                   ⡇⡎             ││                ⠸⡸         ⢰⠁                              ⠈⡎       ⠈⡆              ⢠⠃         ││
││                                                                                   ⡇⡇             ││                                                                                          ││
││                                                                                   ⢱⠇             ││                        ⠘⠊⠉                                          ⠘⡄⢸        ⠘⠒⠊⠉⠉⠉⠉          ││
││   2390                                                                                          ││    3330                                                               ⠈⢾                         ││
││       └───────────────────────────────────────────────────────────────────────────────────────────││        └──────────────────────────────────────────────────────────────────────────────────────────││
││        2020-03-07 0115   2020-03-07 0139   2020-03-07 0134   2020-03-07 0136   2020-03-07 0132    ││         2020-03-07 0115   2020-03-07 0126   2020-03-07 0112   2020-03-07 0134   2020-03-07 0124   ││
│└───────────────────────────────────────────────────────────────────────────────────────────────────┘└───────────────────────────────────────────────────────────────────────────────────────────────────┘│
└──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘

$ ./bin/swctl metrics top 5 --name service_sla        
[{"name":"projectB","id":"2","value":10000},{"name":"projectC","id":"3","value":10000},{"name":"projectA","id":"4","value":10000},{"name":"projectD","id":"5","value":10000}]
$ ./bin/swctl metrics top 5 --name service_instance_sla --service-id 3        
[{"name":"projectC-pid:30335@skywalking-server-0002","id":"13","value":10000},{"name":"projectC-pid:22037@skywalking-server-0001","id":"2","value":10000}]
$ ./bin/swctl metrics top 5 --name endpoint_sla --service-id 3        
[{"name":"/projectC/{value}","id":"4","value":10000}]
$ ./bin/swctl metrics thermodynamic --name all_heatmap
{"values":[{"id":"202008290939","values":[473,3,0,0,0,0,0,0,0,0,323,0,4,0,0,0,0,0,0,0,436]},{"id":"202008290940","values":[434,0,0,0,0,0,0,0,0,0,367,0,4,0,0,0,0,0,0,0,427]},{"id":"202008290941","values":[504,0,0,0,0,0,0,0,0,0,410,0,5,0,1,0,0,0,0,0,377]},{"id":"202008290942","values":[445,0,4,0,0,0,0,0,0,0,350,0,0,0,0,0,0,0,0,0,420]},{"id":"202008290943","values":[436,0,1,0,0,0,0,0,0,0,367,0,3,0,0,0,0,0,0,0,404]},{"id":"202008290944","values":[463,0,0,0,0,0,0,0,0,0,353,0,0,0,0,0,0,0,0,0,416]},{"id":"202008290945","values":[496,0,2,3,0,0,0,0,0,0,372,0,4,0,0,0,0,0,0,0,393]},{"id":"202008290946","values":[460,0,4,0,0,0,0,0,0,0,396,0,0,0,0,0,0,0,0,0,408]},{"id":"202008290947","values":[533,0,0,0,0,0,0,0,0,0,400,0,0,0,0,0,0,0,0,0,379]},{"id":"202008290948","values":[539,0,0,0,0,0,0,0,0,0,346,0,1,0,0,0,0,0,0,0,424]},{"id":"202008290949","values":[476,0,0,0,1,0,0,0,0,0,353,0,0,0,3,0,0,0,0,0,435]},{"id":"202008290950","values":[509,0,0,0,0,0,0,0,0,0,371,0,0,0,0,0,0,0,0,0,398]},{"id":"202008290951","values":[478,0,2,0,0,0,0,0,0,0,367,0,10,0,4,0,0,0,0,0,413]},{"id":"202008290952","values":[564,0,4,0,0,0,0,0,0,0,342,0,4,0,0,0,0,0,0,0,414]},{"id":"202008290953","values":[476,0,4,0,0,0,0,0,0,0,448,0,4,0,0,0,0,0,0,0,372]},{"id":"202008290954","values":[502,0,1,0,0,0,0,0,0,0,394,0,7,0,0,0,0,0,0,0,392]},{"id":"202008290955","values":[490,0,2,0,0,0,0,0,0,0,383,0,7,0,0,0,0,0,0,0,407]},{"id":"202008290956","values":[474,0,5,0,0,0,0,0,0,0,397,0,3,0,0,0,0,0,0,0,393]},{"id":"202008290957","values":[484,0,4,0,0,0,0,0,0,0,383,0,0,0,0,0,0,0,0,0,402]},{"id":"202008290958","values":[494,0,8,0,0,0,0,0,0,0,361,0,0,0,0,0,0,0,0,0,416]},{"id":"202008290959","values":[434,0,0,0,0,0,0,0,0,0,354,0,0,0,0,0,0,0,0,0,457]},{"id":"202008291000","values":[507,0,1,0,0,0,0,0,0,0,384,0,7,0,0,0,0,0,0,0,405]},{"id":"202008291001","values":[456,0,2,0,0,0,0,0,0,0,388,0,7,0,1,0,0,0,0,0,412]},{"id":"202008291002","values":[506,0,1,0,0,0,0,0,0,0,385,0,0,0,0,0,0,0,0,0,399]},{"id":"202008291003","values":[494,0,8,0,0,0,0,0,0,0,367,0,0,0,0,0,0,0,0,0,415]},{"id":"202008291004","values":[459,0,1,0,0,0,0,0,0,0,263,0,4,0,0,0,0,0,0,0,474]},{"id":"202008291005","values":[513,0,1,0,0,0,0,0,0,0,371,0,3,0,0,0,0,0,0,0,426]},{"id":"202008291006","values":[462,0,1,0,0,0,0,0,0,0,332,0,0,0,0,0,0,0,0,0,435]},{"id":"202008291007","values":[524,0,4,0,1,0,0,0,0,0,365,0,0,0,3,0,0,0,0,0,427]},{"id":"202008291008","values":[442,0,0,0,0,0,0,0,0,0,304,0,0,0,0,0,0,0,0,0,438]},{"id":"202008291009","values":[584,0,0,0,0,0,0,0,0,0,446,0,0,0,0,0,0,0,0,0,343]}],"buckets":[{"min":"0","max":"100"},{"min":"100","max":"200"},{"min":"200","max":"300"},{"min":"300","max":"400"},{"min":"400","max":"500"},{"min":"500","max":"600"},{"min":"600","max":"700"},{"min":"700","max":"800"},{"min":"800","max":"900"},{"min":"900","max":"1000"},{"min":"1000","max":"1100"},{"min":"1100","max":"1200"},{"min":"1200","max":"1300"},{"min":"1300","max":"1400"},{"min":"1400","max":"1500"},{"min":"1500","max":"1600"},{"min":"1600","max":"1700"},{"min":"1700","max":"1800"},{"min":"1800","max":"1900"},{"min":"1900","max":"2000"},{"min":"2000","max":"infinite+"}]}
$ ./bin/swctl --display=graph metrics thermodynamic --name all_heatmap 
$ ./bin/swctl --display graph trace 1585375544413.464998031.46647
$ ./bin/swctl --display graph trace ls --start='2020-08-13 1754' --end='2020-08-20 2020'  --tags='http.method=POST'

if your backend nodes are deployed in docker and the timezone is UTC, you may not want to convert your timezone to UTC every time you type a command, --timezone comes to your rescue.

$ ./bin/swctl --debug --timezone="0" service ls

--timezone="+1200" and --timezone="-0900" are also valid usage.

if you want to check health status from GraphQL and the gRPC endpoint listening on 10.0.0.1:8843.

$ ./bin/swctl checkHealth --grpcAddr=10.0.0.1:8843

If you only want to query GraphQL.

$ ./bin/swctl checkHealth --grpc=false

Once the gRPC endpoint of OAP encrypts communication by TLS.

$ ./bin/swctl checkHealth --grpcTLS=true

Contributing

For developers who want to contribute to this project, see Contribution Guide

License

Apache 2.0 License.