CLI: Diagnostics



On This Page

 


The CLI references “skysync.” This is expected.

Diagnostics Metrics

In the following examples, the authentication parameters are provided within the configuration file.  See the authentication section for more information.

List the Metrics

parameter

description

required

default

parameter

description

required

default

metric, m

Metric name

optional

 

type, t

Metric type

optional

 

search, q

Search text

optional

 

 

Example 1: List all the metrics

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli diagnostics metrics

Example results

1 2 3 4 5 6 7 8 Metric Value Type app.cpu.usage 0.012199251937412236 gauge app.disk.reads_per_sec 0.001687845136870207 gauge app.disk.writes_per_sec 0.0020560817640639635 gauge app.memory.usage 260.875 gauge app.uptime 102586.1691205 gauge app.version.build 0.0.0 gauge ...

 

Command (JSON)

1 skysync-cli diagnostics metrics --json

Example results (JSON)

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 { "name": "app.cpu.usage", "value": 0, "type": "gauge" }, { "name": "app.disk.reads_per_sec", "value": 0.0017287718488986894, "type": "gauge" }, { "name": "app.disk.writes_per_sec", "value": 0.0017188391484965662, "type": "gauge" }

 

Note that json output format via the cli is formatted differently than the native endpoint format.

Native metrics endpoint results

1 2 3 4 5 6 7 8 9 10 11 12 "app.cpu.usage":{ "value":0.023432151072578209, "type":"gauge" }, "app.disk.reads_per_sec":{ "value":0.0017184697141526821, "type":"gauge" }, "app.disk.writes_per_sec":{ "value":0.0017184666282899282, "type":"gauge" }

 

Example 2: List 'app.memory.usage' metric

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli diagnostics metrics -m "app.memory.usage"

Example results

1 2 Metric Value Type app.memory.usage 260.875 gauge

 

Example 3: List all the metrics of the type 'gauge'

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.

Command

1 skysync-cli diagnostics metrics -t "gauge"

Example results

1 2 3 4 5 6 7 8 Metric Value Type app.cpu.usage 0.012199251937412236 gauge app.disk.reads_per_sec 0.001687845136870207 gauge app.disk.writes_per_sec 0.0020560817640639635 gauge app.memory.usage 260.875 gauge app.uptime 102586.1691205 gauge app.version.build 0.0.0 gauge ...

 

Example 4: List all the metrics containing 'cpu' in metric name

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.

Command

1 skysync-cli diagnostics metrics -q "cpu"

Example results

1 2 3 4 5 Metric Value Type app.cpu.usage 0.14757013285911424 gauge system.cpu.arch x64 gauge system.cpu.count 4 gauge system.cpu.usage 3.341562977280177 gauge

 

Diagnostics Fiddler

FiddlerCore, by default, is not enabled in DryvIQ.  DryvIQ must be configured to enable FiddlerCore.  Click here for more information on how to configure DryvIQ to enable FiddlerCore.

In the following examples, the authentication parameters are provided within the configuration file.  See the authentication section for more information.

Status of Fiddler

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli diagnostics fiddler status

Example results

1 2 Status Disabled Port -

Example results

1 2 Status Enabled Port 7777

 

Command (JSON)

1 skysync-cli diagnostics fiddler status --json

Example results (JSON)

1 2 3 4 5 [ { "status": false } ]

 

Enable Fiddler

In the following example, the authentication parameters are provided within the configuration file.  See theauthenticationsection for more information.  

Command

1 skysync-cli diagnostics fiddler enable

Example results

1 2 Status Enabled Port 7777

 

command (JSON)

1 skysync-cli diagnostics fiddler enable --json

Example results (JSON)

1 2 3 4 5 6 [ { "status": true, "port": 7777 } ]

 

Disable Fiddler

In the following example, the authentication parameters are provided within the configuration file.  See theauthenticationsection for more information.  

Command

1 skysync-cli diagnostics fiddler disable

Example results

1 2 Status Disabled Port -

 

Command (JSON)

1 skysync-cli diagnostics fiddler disable--json

Example results (JSON)

1 2 3 4 5 [ { "status": false } ]

 

Download Fiddler Traces

parameter

description

required

default

parameter

description

required

default

targetDirectory

Relative or absolute path to save the downloaded installation package

optional

(current directory)

Example 1: Download the Fiddler traces

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli diagnostics fiddler download

Example results

1 File saved to c:\skysync-cli\2019-09-09T14-02-23Z.zip

 

Example 2: Download the Fiddler traces to a specified directory

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli diagnostics fiddler download --targetDirectory={{targetDirectory}}

Command with example values

1 skysync-cli diagnostics fiddler download --targetDirectory=c:\fiddlerTraces

Example results

1 File saved to c:\fiddlerTraces\2019-09-09T14-02-23Z.zip

 

Purge Fiddler Traces

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli diagnostics fiddler purge

Example results

1 Fiddler traces were removed from node.

 

Uninstall Fiddler Root Certificates

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli diagnostics fiddler uninstall-certs

Example results

1 Fiddler is not available on this node.

 

Install Fiddler Root Certificates

In the following example, the authentication parameters are provided within the configuration file.  See the authentication section for more information.  

Command

1 skysync-cli diagnostics fiddler install-certs

Example results

1 2 Status Disabled Port -

Example results

1 2 Status Enabled Port 7777