CLI: Logging



The CLI references “skysync.” This is expected.

 

The logging level determines the amount of information that is captured and included in the application logs. You would change the logging level if you wanted to capture specific information only in order to troubleshoot issues.

Parameters

Viewing or setting the logging level is done using the following two parameters.

Parameter

Description

Parameter

Description

level

The logging level set. The default value is Info.

retention_days

Number of days the log will be retained. The default value is 21 days.

Log Level

Below are the available log levels that can be set for the application log. Info is the default logging level.

Level

Description

Level

Description

Trace

This level includes all logging levels. This is an ideal logging level to set when troubleshooting as it provides the most comprehensive logging.

Debug

This level logs all basic information, warnings, and errors. It also includes additional information that may be useful for troubleshooting.

Info

This level logs all basic logging, warnings, and errors. This is the default logging level.

Warn

This level logs only warnings and errors.

Error

This level logs only general and critical errors.

Fatal

This level logs only critical errors.

List Logging Levels

Command

1 skysync.js diagnostics logging show

Example result

1 2 3 4 { "level": "trace", "Retention_days": 21 }

 

Updating Logging Information

You can update just the logging level or retention days, or you can update both. At least one parameter must be set in the update command in order for the update to work. An update command without parameters will result in a return message that includes help information for how to update the logging information.

 

Updating the Logging Level

Command

1 skysync.js diagnostics logging update --level={level}

Examples

1 skysync.js diagnostics logging update --level=trace
1 skysync.js diagnostics logging update --level=debug
1 skysync.js diagnostics logging update --level=info
1 skysync.js diagnostics logging update --level=warn
1 skysync.js diagnostics logging update --level=error
1 skysync.js diagnostics logging update --level=fatal

 

Updating the Retention Days

Command

1 skysync.js diagnostics logging update --retention={days}

Examples

1 skysync.js diagnostics logging update --retention=15
1 skysync.js diagnostics logging update --retention=30

 

Updating Both Parameters

There are two commands that can be used to update both parameters. Note that neither option is required, but at least one option must be included.

Command

1 skysync.js diagnostics logging update --level={level} --retention={days}

or

1 skysync.js diagnostics logging update -l={level}-r={days}

Examples

1 skysync.js diagnostics logging update --level=trace --retention=20
1 skysync.js diagnostics logging update --level=warn --retention=15
1 skysync.js diagnostics logging update -l=trace-r=20
1 skysync.js diagnostics logging update -l=warn-r=15

 

When logging is set through the CLI, the changes will be reflected on the Performance page in the Settings once the page is refreshed.