[Bps-public-commit] app-aws-cloudwatch-monitor-check-mailsummary branch add-check-module updated. a9046a21ff4d67a63e48ab45cb823fca7b7a108f

[BPS Git Server]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "app-aws-cloudwatch-monitor-check-mailsummary".

The branch, add-check-module has been updated
       via  a9046a21ff4d67a63e48ab45cb823fca7b7a108f (commit)
      from  31670c70a14e72968106cf51917c9036df87ef1d (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit a9046a21ff4d67a63e48ab45cb823fca7b7a108f
Author: Blaine Motsinger <blaine at bestpractical.com>
Date:   Wed Jan 26 18:22:01 2022 -0600

    Add README.md for display on GitHub

diff --git a/MANIFEST.SKIP b/MANIFEST.SKIP
index 60ea4b4..61c20fc 100644
--- a/MANIFEST.SKIP
+++ b/MANIFEST.SKIP
@@ -37,6 +37,8 @@ MYMETA\.json
 MYMETA\.yml$
 \.tar\.gz$$
 
+README.md
+
 # Author tests and files
 996_perl-tidy.t
 997_perl-critic.t
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..19f3ee9
--- /dev/null
+++ b/README.md
@@ -0,0 +1,56 @@
+# NAME
+
+App::AWS::CloudWatch::Monitor::Check::MailSummary - gather mail traffic summary data
+
+# SYNOPSIS
+
+    my $plugin  = App::AWS::CloudWatch::Monitor::Check::MailSummary->new();
+    my $metrics = $plugin->check( $args_arrayref );
+
+    perl bin/aws-cloudwatch-monitor --check MailSummary --maillog-path /var/log/mail.log --maillog-time 23:00
+
+# DESCRIPTION
+
+`App::AWS::CloudWatch::Monitor::Check::MailSummary` is a `App::AWS::CloudWatch::Monitor::Check` module which gathers mail traffic summary data for a specified hour.
+
+# METRICS
+
+Data for this check is read from [pflogsumm(1)](http://man.he.net/man1/pflogsumm).  The following metrics are returned.
+
+- mail-Received
+- mail-Delivered
+- mail-Deferred
+- mail-Bounced
+- mail-Rejected
+
+# METHODS
+
+- check
+
+    Gathers the metric data and returns an arrayref of hashrefs with keys `MetricName`, `Unit`, `RawValue`.
+
+# ARGUMENTS
+
+- --maillog-path </path/to/maillog>
+
+    The `--maillog-path` argument is required and defines the full path, with filename, where the maillog can be read.
+
+        perl bin/aws-cloudwatch-monitor --check MailSummary --maillog-path /var/log/mail.log
+
+- --maillog-time <hh:mm>
+
+    The optional `--maillog-time` argument may be defined to specify which hour to get mailstats for.
+
+        perl bin/aws-cloudwatch-monitor --check MailSummary --maillog-path /var/log/mail.log --maillog-time 23:00
+
+    `maillog-time` must be formatted 24hr and minute (hh:mm).
+
+    If `maillog-time` isn't defined, mailstats are gathered for the previous hour.
+
+# DEPENDENCIES
+
+`App::AWS::CloudWatch::Monitor::Check::MailSummary` depends on the external program, [pflogsumm(1)](http://man.he.net/man1/pflogsumm).
+
+# BUGS AND ENHANCEMENTS
+
+Please report any bugs or feature requests at [Github](https://github.com/bestpractical/app-aws-cloudwatch-monitor-check-mailsummary/issues).
-----------------------------------------------------------------------

Summary of changes:
 MANIFEST.SKIP |  2 ++
 README.md     | 56 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 58 insertions(+)
 create mode 100644 README.md


hooks/post-receive
-- 
app-aws-cloudwatch-monitor-check-mailsummary