This section describes the following log characteristics for the message store and administration services: logging levels, categories of logged events, filename conventions for logs, and log-file directories.
The level, or priority, of logging defines how detailed, or verbose, the logging activity is to be. A higher priority level means less detail; it means that only events of high priority (high severity) are logged. A lower level means greater detail; it means that more events are recorded in the log file.
You can set the logging level separately for each service—POP, IMAP, HTTP, Admin, and Default by setting the logfile.service.loglevel configuration parameter (see Defining and Setting Service Logging Options). You can also use logging levels to filter searches for log events. Table 21–4 describes the available levels. These logging levels are a subset of those defined by the UNIX syslog facility.
Table 21–4 Logging Levels for Store and Administration Services
Level |
Description |
---|---|
Critical |
The minimum logging detail. An event is written to the log whenever a severe problem or critical condition occurs—such as when the server cannot access a mailbox or a library needed for it to run. |
Error |
An event is written to the log whenever an error condition occurs—such as when a connection attempt to a client or another server fails. |
Warning |
An event is written to the log whenever a warning condition occurs—such as when the server cannot understand a communication sent to it by a client. |
Notice |
An event is written to the log whenever a notice (a normal but significant condition) occurs—such as when a user login fails or when a session closes. This is the default log level. |
Information |
An event is written to the log with every significant action that takes place—such as when a user successfully logs on or off or creates or renames a mailbox. |
Debug |
The most verbose logging. Useful only for debugging purposes. Events are written to the log at individual steps within each process or task, to pinpoint problems. |
When you select a particular logging level, events corresponding to that level and to all higher (less verbose) levels are logged. The default level of logging is Notice.
The more verbose the logging you specify, the more disk space your log files will occupy; for guidelines, see Defining and Setting Service Logging Options
Within each supported service or protocol, Messaging Server further categorizes logged events by the facility, or functional area, in which they occur. Every logged event contains the name of the facility that generated it. These categories aid in filtering events during searches. Table 21–5 lists the categories that Messaging Server recognizes for logging purposes.
Table 21–5 Categories in Which Log Events Occur
Facility |
Description |
---|---|
General |
Undifferentiated actions related to this protocol or service |
LDAP |
Actions related to Messaging Server accessing the LDAP directory database |
Network |
Actions related to network connections (socket errors fall into this category) |
Account |
Actions related to user accounts (user logins fall into this category) |
Protocol |
Protocol-level actions related to protocol-specific commands (errors returned by POP, IMAP, or HTTP functions fall into this category) |
Stats |
Actions related to the gathering of server statistics |
Store |
Low-level actions related to accessing the message store (read/write errors fall into this category) |
For examples of using categories as filters in log searches, see Searching and Viewing Service Logs
Every logged service is assigned a single directory, in which its log files are stored. All IMAP log files are stored together, as are all POP log files, and log files of any other service. You define the location of each directory, and you also define how many log files of what maximum size are permitted to exist in the directory.
Make sure that your storage capacity is sufficient for all your log files. Log data can be voluminous, especially at lower (more verbose) logging levels.
It is important also to define your logging level, log rotation, log expiration, and server-backup policies appropriately so that all of your log-file directories are backed up and none of them become overloaded; otherwise, you may lose information. See Defining and Setting Service Logging Options.