...
| align | center |
|---|
...
On This Page
| Table of Contents | ||||
|---|---|---|---|---|
|
...
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 |
|---|---|---|---|
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
| Code Block |
|---|
skysync-cli diagnostics metrics |
Example results
| Code Block |
|---|
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)
| Code Block |
|---|
skysync-cli diagnostics metrics --json |
Example results (JSON)
| Code Block |
|---|
{
"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
| Code Block |
|---|
"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
| Code Block |
|---|
skysync-cli diagnostics metrics -m "app.memory.usage" |
Example results
| Code Block |
|---|
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
| Code Block |
|---|
skysync-cli diagnostics metrics -t "gauge" |
Example results
| Code Block |
|---|
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
| Code Block |
|---|
skysync-cli diagnostics metrics -q "cpu" |
Example results
| Code Block |
|---|
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
| Panel | ||
|---|---|---|
| ||
FiddlerCore, by default, is not enabled in SkySync. SkySync must be configured to enable FiddlerCore. Click here for more information on how to configure SkySync 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
| Code Block |
|---|
skysync-cli diagnostics fiddler status |
Example results
| Code Block |
|---|
Status Disabled
Port - |
Example results
| Code Block |
|---|
Status Enabled
Port 7777 |
Command (JSON)
| Code Block |
|---|
skysync-cli diagnostics fiddler status --json |
Example results (JSON)
| Code Block |
|---|
[
{
"status": false
}
]
|
Enable Fiddler
In the following example, the authentication parameters are provided within the configuration file. See theauthenticationsection for more information.
Command
| Code Block |
|---|
skysync-cli diagnostics fiddler enable |
Example results
| Code Block |
|---|
Status Enabled
Port 7777 |
command (JSON)
| Code Block |
|---|
skysync-cli diagnostics fiddler enable --json |
Example results (JSON)
| Code Block |
|---|
[
{
"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
| Code Block |
|---|
skysync-cli diagnostics fiddler disable |
Example results
| Code Block |
|---|
Status Disabled
Port - |
Command (JSON)
| Code Block |
|---|
skysync-cli diagnostics fiddler disable--json |
Example results (JSON)
| Code Block |
|---|
[
{
"status": false
}
] |
Download Fiddler Traces
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
| Code Block |
|---|
skysync-cli diagnostics fiddler download |
Example results
| Code Block |
|---|
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
| Code Block |
|---|
skysync-cli diagnostics fiddler download --targetDirectory={{targetDirectory}} |
Command with example values
| Code Block |
|---|
skysync-cli diagnostics fiddler download --targetDirectory=c:\fiddlerTraces |
Example results
| Code Block |
|---|
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
| Code Block |
|---|
skysync-cli diagnostics fiddler purge |
Example results
| Code Block |
|---|
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
| Code Block |
|---|
skysync-cli diagnostics fiddler uninstall-certs |
Example results
| Code Block |
|---|
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
| Code Block |
|---|
skysync-cli diagnostics fiddler install-certs |
Example results
| Code Block |
|---|
Status Disabled
Port - |
Example results
| Code Block |
|---|
Status Enabled
Port 7777 |