The smpp_bounce_logger Module

March 26, 2020 Contributors

It is often convenient to look at bounced SMPP messages only. The smpp_bounce_logger makes this much easier by writing bounces—both in-band and out-of-band bounce messages—to a single file in ‘@’ delimited format.

The writing of smpp_bounce_logger format logs is configured in your ecelerity.conf file. To load the smpp_bounce_logger module, add the following lines to the main body of your ecelerity.conf file or add the smpp_bounce_logger module using the web console:

smpp_bounce_logger "smpp_bounce_logger1" {
  bounce_concurrency = 1
  bounce_logfile = "/var/log/ecelerity/smppbouncelog.ec"
}

A complete list of the available configuration options follows:

bounce_concurrency

This option defines the number of threads in the pool. The default value for this option is 1.

bounce_logfile

This option determines the name of the log file. The default value for this option is /var/log/ecelerity/smppbouncelog.ec.

bounce_logmode

The mode of the log file in octal notation. The default value for this option is 0644.

bounce_namespace

This option specifies which macro namespaces should be searched, when expanding the format strings. This variable is set using commas to separate different namespaces. The default value for this option is smpp_bounce_logger,sieve,custom_logger.

bounce_thread_pool

Define a separate thread pool for bounces. Otherwise the io pool is used. For more information about defining thread pools see threadpool.

heartbeat

The interval at which "heartbeat" entries will be written to the log. The default value for this option is 60.

log_bounce_heartbeat_format

This option determines the format of the heartbeat log. The default value for this option is %[email protected] where the macro %t indicates a Unix timestamp and M is a literal indicating that this log entry is a heartbeat.

log_bounce_inband

Whether or not to log inband bounces. The default value for this option is true.

log_bounce_inband_format

This option defines the format of the inband bounces log. The default value for this option is %[email protected]@%[email protected]%[email protected]%[email protected]%[email protected]%[email protected]%[email protected]%[email protected]%e. How these macros are expanded is described in Table 2.1, “Log format macros”. In this case I is a literal indicating that this is an inband log entry.

log_bounce_outband

Whether or not to log out-of-band bounces. The default value for this option is true.

log_bounce_outband_format

This option defines the format of the out-of-band bounces log. The default value for this option is %[email protected]@%[email protected]%[email protected]%[email protected]%[email protected]%[email protected]%[email protected]%[email protected]%e. How these macros are expanded is described in Table 2.1, “Log format macros”. In this case O is a literal indicating that this is an out-of-band log entry.

log_bounce_transient

Whether or not to log transient bounces. The default value for this option is true.

log_bounce_transient_format

This option defines the format of transient bounces log. The default value for this option is %[email protected]@%[email protected]%[email protected]%[email protected]%[email protected]%[email protected]%[email protected]%[email protected]%e. How these macros are expanded is described in Table 2.1, “Log format macros”. In this case T is a literal indicating that this is a transient failure log entry.