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

[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-fail2ban".

The branch, add-check-module has been updated
       via  f2ba0dff2e23f25deeef22e8cbd106c607e5887c (commit)
      from  b54b4c8a9e65496b759c620b7684c1bbf036dfd5 (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 f2ba0dff2e23f25deeef22e8cbd106c607e5887c
Author: Blaine Motsinger <blaine at bestpractical.com>
Date:   Wed Jan 26 18:21:11 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..71baba0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,46 @@
+# NAME
+
+App::AWS::CloudWatch::Monitor::Check::Fail2Ban - gather fail2ban jail metrics
+
+# SYNOPSIS
+
+    my $plugin  = App::AWS::CloudWatch::Monitor::Check::Fail2Ban->new();
+    my $metrics = $plugin->check();
+
+    perl bin/aws-cloudwatch-monitor --check Fail2Ban
+
+# DESCRIPTION
+
+`App::AWS::CloudWatch::Monitor::Check::Fail2Ban` is a [App::AWS::CloudWatch::Monitor::Check](https://metacpan.org/pod/App::AWS::CloudWatch::Monitor::Check) module which gathers fail2ban jail metrics.
+
+# METRICS
+
+Data for this check is read from [fail2ban-client(1)](http://man.he.net/man1/fail2ban-client).  The following metrics are returned.
+
+- fail2ban-CurrentlyBanned
+
+    The cumulative currently banned for all active jails.
+
+- fail2ban-TotalBanned
+
+    The cumulative total banned for all active jails.
+
+# METHODS
+
+- check
+
+    Gathers the metric data and returns an arrayref of hashrefs with keys `MetricName`, `Unit`, `RawValue`.
+
+# DEPENDENCIES
+
+`App::AWS::CloudWatch::Monitor::Check::Fail2Ban` depends on the external program, [fail2ban-client(1)](http://man.he.net/man1/fail2ban-client).
+
+# KNOWN ISSUES
+
+[fail2ban-client(1)](http://man.he.net/man1/fail2ban-client) requires root privileges to read the logfiles.  This check must also be run with root privileges because of its dependency on [fail2ban-client(1)](http://man.he.net/man1/fail2ban-client).
+
+    Permission denied to socket: /var/run/fail2ban/fail2ban.sock, (you must be root)
+
+# BUGS AND ENHANCEMENTS
+
+Please report any bugs or feature requests at [Github](https://github.com/bestpractical/app-aws-cloudwatch-monitor-check-fail2ban/issues).
-----------------------------------------------------------------------

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


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