Mail Notification for Specified Server Logs

Mail notification is available for specified server logs. As an administrator, you can decide the server logs information to be notified by email through specifying regular expression or the combination of log levels and regular expression.

To use the mail notification feature, you should first configure the SMTP related parameter in the server.conf file and then configure the logging parameters as described in the following table. These logging parameters are added in the logging.conf file located in the <PPM_Home>/conf directory.

Parameter Name
(*Required, **Required If)

Description, Usage

Default and Valid
Values

ENABLE_SMTP_LOGGING

If set to true, mail notification for critical exceptions is enabled.

Default: false

Valid values: true, false

**SMTP.To

Required if ENABLE_SMTP_LOGGING is set to true

The recipient of the notification.

Default: N/A

Valid values: Email address

SMTP.From

The sender of the notification.

If not specified, the email address of the sender is derived from EMAIL_NOTIFICATION_SENDER in the server.conf file.

Default: N/A

Valid values: Email address

SMTP.Subject

The subject of the notification mail.

Default: N/A

**SMTP.Filter.
RegexToMatch

Required if ENABLE_SMTP_LOGGING is set to true

The keyword or regular expression to be monitored.

Default: N/A

Valid values: Regular expression

For example, OutOfMemoryError|\w+\d{2}|Exception

SMTP.Filter.LevelMin

The lowest log level to be monitored.

Default: N/A

Valid values: trace/debug/info/warn/
error/fatal

SMTP.Filter.LevelMax

The highest log level to be monitored.

Default: N/A

Valid values: trace/debug/info/warn/
error/fatal

SMTP.delayBetwee
nChecksInSeconds

The time interval (in seconds) to check message queues.

Default: 10

Valid values: > 0

SMTP.SMTPDebug

If set to true, enables displaying debug information when mail notification is sent out.

Default: false

Valid values: true, false

SMTP.BufferSize

The buffer queue length.

Default: 512

Valid values: > 0

Note:  

  • The same server log information generated several times within an hour is sent out only once per hour.
  • If the information in the logging.conf file conflicts with this document, refer to this document for instructions.

If you want to monitor the InfrastructureException issue only and receive emails about the issue, you can set the parameters as follows:

Parameter Name Parameter Value

ENABLE_SMTP_LOGGING

true

SMTP.To

admin@yourdomain.com

SMTP.From

sender@youdomain.com or null

SMTP.Subject

Notification Report

SMTP.Filter.RegexToMatch

InfrastructureException

SMTP.Filter.LevelMin

debug

SMTP.Filter.LevelMax

fatal

You will receive emails with the content similar to the following: