[Bps-public-commit] app-aws-cloudwatch-monitor-check-mailqueue branch add-check-module updated. 767f0375ccc6fdec854068cce715cf054f7a7bf2
BPS Git Server
git at git.bestpractical.com
Thu Jan 27 00:22:51 UTC 2022
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-mailqueue".
The branch, add-check-module has been updated
via 767f0375ccc6fdec854068cce715cf054f7a7bf2 (commit)
from 1d200495b4ecfefbc2afaae05d68bb3cb3500402 (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 767f0375ccc6fdec854068cce715cf054f7a7bf2
Author: Blaine Motsinger <blaine at bestpractical.com>
Date: Wed Jan 26 18:22:45 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..2d061d7
--- /dev/null
+++ b/README.md
@@ -0,0 +1,34 @@
+# NAME
+
+App::AWS::CloudWatch::Monitor::Check::MailQueue - gather mail queue count
+
+# SYNOPSIS
+
+ my $plugin = App::AWS::CloudWatch::Monitor::Check::MailQueue->new();
+ my $metrics = $plugin->check();
+
+ perl bin/aws-cloudwatch-monitor --check MailQueue
+
+# DESCRIPTION
+
+`App::AWS::CloudWatch::Monitor::Check::MailQueue` is a `App::AWS::CloudWatch::Monitor::Check` module which gathers current mail queue count.
+
+# METRICS
+
+Data for this check is read from [mailq(1)](http://man.he.net/man1/mailq). The following metrics are returned.
+
+- mail-Queue
+
+# METHODS
+
+- check
+
+ Gathers the metric data and returns an arrayref of hashrefs with keys `MetricName`, `Unit`, `RawValue`.
+
+# DEPENDENCIES
+
+`App::AWS::CloudWatch::Monitor::Check::MailQueue` depends on the external program, [mailq(1)](http://man.he.net/man1/mailq).
+
+# BUGS AND ENHANCEMENTS
+
+Please report any bugs or feature requests at [Github](https://github.com/bestpractical/app-aws-cloudwatch-monitor-check-mailqueue/issues).
-----------------------------------------------------------------------
Summary of changes:
MANIFEST.SKIP | 2 ++
README.md | 34 ++++++++++++++++++++++++++++++++++
2 files changed, 36 insertions(+)
create mode 100644 README.md
hooks/post-receive
--
app-aws-cloudwatch-monitor-check-mailqueue
More information about the Bps-public-commit
mailing list