Configure logging by going to System Console > Environment > Logging, or by editing the config.json
file as described in the following tables. Changes to configuration settings in this section require a server restart before taking effect.
Tip
You can manage additional logging configuration within the config.json
file specifically for Mattermost notifications under NotificationLogSettings
. These settings are equivalent to the configuration settings available under LogSettings
.
Output logs to console#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Configure Mattermost to output logs to the console.
|
|
Console log level#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The level of detail in log events written when Mattermost outputs log messages to the console.
|
|
Output console logs as JSON#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Configure Mattermost to output console logs as JSON.
|
|
Note: Typically set to true in a production environment. |
Colorize plain text console logs#
Enables system admins to display plain text log level details in color.
|
|
Output logs to file#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Configure Mattermost to output console logs to a file.
|
|
Note: Typically set to true in a production environment. |
File log directory#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The location of the log files. String input. If left blank, log files are
stored in the |
|
Note: The path you configure must exist, and Mattermost must have write permissions for this directory. |
File log level#
Also available in legacy Mattermost Enterprise Edition E10 or E20
The level of detail in log events when Mattermost outputs log messages to a file.
|
|
Output file logs as JSON#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Configure Mattermost to output file logs as JSON.
|
|
Note: Typically set to true in a production environment. |
Enable webhook debugging#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Configure Mattermost to capture the contents of incoming webhooks to console and/or file logs for debugging.
|
|
Note: Enable debug logs by changing the file log level to |
Output logs to multiple targets#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Configure Mattermost to allow any combination of console, local file, syslog, and TCP socket targets, and send log records to multiple targets. String input can contain a filespec to another configuration file, a database DSN, or JSON. |
|
Notes:
|
|
Note: See the Mattermost logging documentation for details. |
Maximum field size#
Enables system admins to limit the size of log fields during logging. Numerical value. Default is 2048. |
|
Enable diagnostics and error reporting#
Also available in legacy Mattermost Enterprise Edition E10 or E20
Whether or not diagnostics and error reports are sent to Mattermost, Inc.
|
|
Note: See the telemetry docummentation for details on the information Mattermost collects. |