CLI: Logging
Learn how to use the CLI to set the logging level for the application logs.
Written by Andrea Harvey
Updated at April 28th, 2025
Table of Contents
The CLI references “skysync.” This is expected.
Overview
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 want to capture specific information only to troubleshoot issues.
Parameters
| 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 |
|---|---|
| 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
skysync.js diagnostics logging showExample Result
{
"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
skysync.js diagnostics logging update --level={level}Examples
skysync.js diagnostics logging update --level=traceskysync.js diagnostics logging update --level=debugskysync.js diagnostics logging update --level=infoskysync.js diagnostics logging update --level=warnskysync.js diagnostics logging update --level=errorskysync.js diagnostics logging update --level=fatalUpdating Retention Days
The Retention Days setting determines how long logs are retained.
Command
skysync.js diagnostics logging update --retention={days}Examples
skysync.js diagnostics logging update --retention=15skysync.js diagnostics logging update --retention=30Updating Both Parameters
Command
skysync.js diagnostics logging update --level={level} --retention={days}or
skysync.js diagnostics logging update -l={level}-r={days}
Examples
skysync.js diagnostics logging update --level=trace --retention=20skysync.js diagnostics logging update --level=warn --retention=15skysync.js diagnostics logging update -l=trace-r=20skysync.js diagnostics logging update -l=warn-r=15When logging is set through the CLI, the changes will be reflected on the Performance page in the Settings once the page is refreshed.