PMDF System Manager's Guide
Previous Next Contents Index

7.3.6 Logging, Monitoring, and Counters Options

The options listed in this section affect PMDF logging, monitoring, and counters. The CIRCUITCHECK_COMPLETED_BINS option relates to PMDF circuit check counter binning. The LOG_DELAY_BINS and LOG_SIZE_BINS options relate to PMDF counters binning. The LOG_SNDOPR option can be set by sites that want to have OPCOM messages (OpenVMS) or syslog messages (UNIX) or event log entries (NT) in cases of logging or counters updating problems. OpenVMS sites that have heavy message traffic logged to the PMDF log file can find it useful to adjust the LOG_ALQ and LOG_DEQ option so that the underlying file allocation uses larger extents. The rest of these logging options affect the formatting of the PMDF log file and logging of optional additional information.

CIRCUITCHECK_COMPLETED_BINS (comma-separated list of up to eight integers)

This option specifies the bin divisions, in seconds, for the PMDF circuit check counters. The default values are 120, 300, 900, 1800, 3600, 7200, 14400, and 28800; i.e., two minutes, five minutes, fifteen minutes, thirty minutes, one hour, two hours, four hours, and eight hours, respectively.

LOG_ALQ (integer; OpenVMS only)

The LOG_ALQ option specifies the default allocation quantity (in OpenVMS blocks) for the PMDF log file, mail.log_current. The default value is 2000, or twice the LOG_DEQ value if LOG_DEQ has been explicitly set. On a busy system that is updating that log file frequently, increasing this value can provide increased efficiency.

LOG_CONNECTION (integer)

The LOG_CONNECTION option controls whether or not connection information, e.g., the domain name of the SMTP client sending the message, is saved in the mail.log file. This value is a decimal integer representing a bit-encoded integer, the interpretation of which is given in the table below.
Bit Value Usage
0 1 When set, connection information is included in E, D and R log records.
1 2 When set, connection open/close/fail records are logged by message enqueue and dequeue agents such as the SMTP and X.400 clients and servers. This bit also enables use of the $T flag (for causing logging) in PORT_ACCESS rejection entries.
2 4 When set, I records are logged recording ETRN events.
4 16 When set, C entries can include site-supplied text from a PORT_ACCESS mapping table entry.
Bit 0 is the least significant bit.
Thus for instance enabling LOG_CONNECTION=3 will result both in additional sorts of log file entries---entries showing when an SMTP connection is opened or closed---and also additional information in regular log file entries showing the name of the system connecting (or being connected to), or the channel hostname of the enqueuing channel when the enqueuing channel is not an SMTP channel. (This is a change from PMDF V5.1 and earlier, where the value was simply 0 or 1, with 1 enabling all the then-available connection logging.) TCP/IP channels have a channel level option that can override this setting for particular channels; see Section 23.1.2.2. For examples of the sort of information resulting from setting LOG_CONNECTION=3, see Figure 33-10 and Figure 33-11.

LOG_CONNECTIONS_SYSLOG (integer; UNIX and NT only)

Send PMDF connection log file entries to syslog (UNIX) or event log (NT).

LOG_DELAY_BINS (comma-separated list of up to five integers)

This option specifies the bin divisions for the PMDF counters tracking numbers of messages delivered in the specified number of seconds. The defaults values are 60, 600, 6000, 60000, 600000.

LOG_DEQ (integer; OpenVMS only)

The LOG_DEQ option specifies the default extend quantity (in OpenVMS blocks) for the PMDF log file, mail.log_current. The default value is 1000. On a busy system that is updating that log file frequently, increasing this value can provide increased efficiency.

LOG_FILENAME (0 or 1)

The LOG_FILENAME option controls whether or not the names of the files in which messages are stored are saved in the mail.log file. A value of 1 enables file name logging. When file name logging is enabled, the file name will appear as the first field after the final form envelope To: address. A value of 0 (the default) disables file name logging.

LOG_FORMAT (1, 2, or 3)

The LOG_FORMAT option controls formatting options for the mail.log file. A value of 1 (the default) is the standard format. A value of 2 requests non-null formatting: empty address fields are converted to the string "<>". A value of 3 requests counted formatting: all variable length fields are preceded by "N:", where "N" is a count of the number of characters in the field.

LOG_HEADER (0 or 1)

The LOG_HEADER option controls whether PMDF writes message headers to the mail.log file. A value of 1 enables message header logging. The specific headers written to the log file are controlled by a site-supplied log_header.opt file. The format of this file is that of other PMDF header option files; see Section 2.3.7. For instance, a log_header.opt file containing 


To: MAXIMUM=1 
From: MAXIMUM=1 
Defaults: MAXIMUM=-1
would result in writing the first To: and the first From: header per message to the log file. A value of 0 (the default) disables message header logging.

LOG_LOCAL (0 or 1)

The LOG_LOCAL option controls whether or not the domain name for the local host is appended to logged addresses that don't already contain a domain name. A value of 1 enables this feature, which is useful when logs from multiple systems running PMDF are concatenated and processed. A value of 0, the default, disables this feature.

LOG_MESSAGE_ID (0 or 1)

The LOG_MESSAGE_ID option controls whether or not message IDs are saved in the mail.log file. A value of 1 enables message ID logging. When message ID logging is enabled, the message ID will be logged after the final form envelope To: address entry---and after the message file name, if LOG_FILENAME=1 is also enabled. A value of 0 (the default) disables message ID logging.

LOG_MESSAGES_SYSLOG (integer; UNIX and NT only)

Send PMDF message log file entries to syslog (UNIX) or event log (NT). A value of 1 adds entries to both the syslog/event log and to the mail.log file. A value of 2 adds entries only to syslog/event log (not to mail.log).

LOG_NODE (0 or 1; OpenVMS only)

The LOG_NODE option controls whether or not the node associated with a process that enqueues mail is saved in the mail.log file. This can be useful information when PMDF is running in a multi-node cluster. A value of 1 enables node name logging. When the node name is logged, it will appear as the first field following the date and time stamps in log entries. A value of 0 (the default) disables node name logging.

LOG_NOTARY (0 or 1)

The LOG_NOTARY option controls whether PMDF includes an indicator of NOTARY (delivery receipt) flags in the mail.log file entries. A value of 1 enables NOTARY flag logging. A value of 0 (the default) disables it. The NOTARY flags will be logged as a bit encoded integer after the current form of the envelope To: address.

LOG_PROCESS (0 or 1)

The LOG_PROCESS option controls whether or not the id of the process that enqueues mail is saved in the mail.log file. A value of 1 enables process id logging. A value of 0 (the default) disables it. The process id will be logged after the date and time stamps in log entries---and after the node name, if LOG_NODE=1 is also enabled. The process id field itself will consist of the process id in a hexadecimal representation followed by a period, next in the case of a multithreaded channel the thread id followed by a period, followed by a counter. That is, in the case of a single threaded channel 


process-id.counter
or in the case of a multithreaded channel 


process-id.thread-id.counter
Note in particular that via the process id and thread id, TCP/IP channel message enqueue/dequeue (E/D) records can be correlated with SMTP connection open/close (O/C) records.

LOG_SENSITIVITY (0 or 1)

The LOG_SENSITIVITY option controls whether message Sensitivity: header values are included in log entries. A value of 1 enables such logging; the default value of 0 disables such logging. If logging is enabled, the sensitivity value will be logged in an integer representation after the connection information, before the transport information.

LOG_SIZE_BINS (comma-separated list of up to five integers)

This option specifies the bin divisions for the PMDF counters tracking numbers of messages of the specified number of (PMDF) blocks. The default values are 2, 10, 50, 100, 500.

LOG_SNDOPR (0 or 1)

The LOG_SNDOPR option controls the production of OPCOM messages (OpenVMS) or syslog messages (UNIX) or event log entries (NT) by the PMDF message logging facility. If this feature is enabled by specifying a value of 1, the logging facility will produce a message if it encounters any difficulty writing to the log file. A value of 0 (the default) turns off these messages.

LOG_USERNAME (0 or 1)

The LOG_USERNAME option controls whether or not the username associated with a process that enqueues mail is saved in the mail.log file. Note that messages submitted via SMTP with authentication (SMTP AUTH) will be considered to be owned by the username that authenticated, prefixed with the asterisk, *, character. A value of 1 enables username logging. When username logging is enabled, the username will be logged after the final form envelope To: address field in log entries---and after the message ID, if LOG_MESSAGE_ID=1 is also enabled. A value of 0 (the default) disables username logging.

SEPARATE_CONNECTION_LOG (0 or 1)

The SEPARATE_CONNECTION_LOG option controls whether the connection log information generated by setting LOG_CONNECTION=1 is stored in the usual PMDF message logging files, mail.log*, or stored separately in connection.log* files. SEPARATE_CONNECTION_LOG=0, the default, causes connection logging to be stored in the regular message log files; a value of 1 causes the connection logging to be stored separately.

SNDOPR_PRIORITY (integer)

Set the priority of operator broadcast or the syslog level of syslog messages or the severity of the NT event log entry.

Previous Next Contents Index