...
- Create/Edit the system environment variable for VERA_SERVER_LOG_LEVEL
- The variable value can be set to any of the levels in the table below.
- By default, the logging level will be set to INFO. This means that if the environment variable is not configured at all or contains a value not supported by VERA as shown in the table below, the INFO logging level will be used.
| Level | Description |
|---|---|
| INFO | An informational listing of messages between the VERA API and external consumers. |
| FULL | A verbose listing of all internal and external messages along with their payloads for VERA Server. |
| NONE | Disables all logging for VERA server messages |
Additional Logging and Controls
VERA Server provides troubleshooting information through several log files and logging levels within those files.
| Log Name | Log File | Description | Log Level | Included Information |
|---|---|---|---|---|
| Info | vera-server-info | Logs provided by ASP.Net Core | Information | All logging provided by ASP.Net Core |
| Errors | vera-server-errors | Errors and Exceptions encountered during processing | Error | Errors and Exceptions |
| Database | vera-server-database | MongoDB database interactions | Error | Connection Failed Command Failed |
| Information | Connection Created Connection Opened Connection Closed | |||
| Debug | Connection Opening Connection Closing Command Started Command Succeeded | |||
| Messages | vera-server-messages | Primary External and Internal Messaging | Information | Messaging according to the VERA_SERVER_LOG_LEVEL environment variable as described above. |
| Messages qTest | vera-server-messages-qtest | Messaging between VERA and the qTest API | Information | Request and response at qTest API endpoints |
| Debug | Payloads with the qTest API messages | |||
| Messages Jira | vera-server-messages-jira | Messaging between VERA and the Jira API | Information | Request and response at Jira API endpoints |
| Debug | Payloads with the qTest API messages |
Log Levels
The supported log levels from least information to most is:
...
For example: vera-server-messages-20220824 001.gz
Configuring Logging
Logging settings can be modified via a "logging-settings.json" file in the Configs folders off of the path specified in the VERA_SERVER_DATA_DIR environment variable.
This is a JSON file with settings for each Log file. Configuration of a particular log can be done by adding an appropriate section to the file. Configuration that matches the defaults is as follows using the Messages log as the example:
| Code Block |
|---|
"Messages": {
"MinimumLevel": "Information",
"WriteTo": [
{ "Name": "File",
"Args": {
"path": "%VERA_SERVER_DATA_DIR%/Logs/vera-server-messages-.txt",
"outputTemplate": "{Timestamp:yyyy-MM-dd HH:mm:ss.fff zzz} [{Level:u3}] {Message}{NewLine}",
"rollingInterval": "Day",
"rollOnFileSizeLimit": true,
"hooks": "Vera.Logging.SerilogHooks::ArchiveHooks, Vera.Logging"
}
}
]
} |
...
See /Lin