ad_summary

March 26, 2020 Contributors

Name

ad_summary — summarize the adaptive module actions

Synopsis

/opt/msys/ecelerity/bin/ad_summary [ –adlogdir [/path/to/adaptive/log/dir/] ]

/opt/msys/ecelerity/bin/ad_summary [ –bouncelog [/path/to/bouncelog] ]

/opt/msys/ecelerity/bin/ad_summary [ –help ]

/opt/msys/ecelerity/bin/ad_summary [ –mailfrom addr ]

/opt/msys/ecelerity/bin/ad_summary [ –mailhost hostname[:port] ]

/opt/msys/ecelerity/bin/ad_summary [ –mailto addr ]

/opt/msys/ecelerity/bin/ad_summary [ –mainlog [/path/to/mainlog] ]

/opt/msys/ecelerity/bin/ad_summary [ –num_bindings [num] ]

/opt/msys/ecelerity/bin/ad_summary [ –num_domains [num] ]

/opt/msys/ecelerity/bin/ad_summary [ –paniclog [/path/to/paniclog] ]

Description

The ad_summary script creates a summary of the contents of the paniclog and mainlog file, including adjustments made by Adaptive Delivery. When the adaptive module is installed, an entry that runs ad_summary is added to /etc/cron.d/msys-ecelerity. This script is run nightly as a cron job and sent via email to the recipient defined by the option Adaptive_Alert_Email_Destination. This summary is created regardless of whether alerts have been generated or not. The default format of the compressed summary files is bzip2 and is controlled by the ec_rotate script.

Note

Adjusting the format of this report by changing the parameters passed to the ad_summary script is not recommended. Any changes made will be overwritten if the application is upgraded.

This command will not run the first day that a Momentum system is live. As a workaround, first run ec_rotate.

The ad_summary command creates the log file, /var/log/ecelerity/adaptive.summary, and this log should be added to ec_rotate.conf. For details, see ec_rotate.conf File”.

If you are not using the adaptive module, there is no need to use this script.

–adlogdir [*`/path/to/adaptive/log/dir/`*]

Location of the adaptive log files. The files that are processed vary depending upon the setting of the adaptive option Split_Logs_By_Binding.

Default value is /var/log/ecelerity/adaptive.

–bouncelog [*`/path/to/bouncelog`*]

Bounce log file to operate on. Default value is /var/log/ecelerity/mainlog.ec.1.bz2.

–help

Print the help message.

–mainlog [*`/path/to/mainlog`*]

Main log file to operate on. Default value is /var/log/ecelerity/mainlog.ec.1.bz2.

–mailfrom *`addr`*

Use the specified address as the from address when mailing the summary file.

–mailhost *`hostname[:port_number]`*

Connect to the specified hostname to send the summary. Default value is localhost. If you are not using port 25, you must specify the port.

–mailto *`addr`*

Send the summary to the specified address which must be an email address of the form user@hostname. If no –mailto argument is specified, the summary will be printed to the standard output.

–num_bindings [*`num`*]

Summarize the top number of bindings specified. By default, the top 20 bindings will be summarized.

–num_domains [*`num`*]

Summarize the top number of domains. By default, the top 20 domains will be summarized.

–paniclog [*`/path/to/paniclog`*]

Panic log file to operate on. Default value is /var/log/ecelerity/paniclog.ec.1.bz2.

See Also

“adaptive – Adaptive Delivery”