1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-22 14:16:00 +00:00

nginx_error: improve documentation

This commit is contained in:
Lars Kruse 2018-01-20 01:45:26 +01:00
parent 7ed71b441d
commit 24ea5d29e9

View file

@ -7,21 +7,27 @@
nginx error - Munin plugin to monitor nginx error rates (http status codes per minute). nginx error - Munin plugin to monitor nginx error rates (http status codes per minute).
=head1 APPLICABLE SYSTEMS =head1 APPLICABLE SYSTEMS
Any Linux host, running nginx, with bash version > 4.0 Any host running nginx, with bash version > 4.0
=head1 CONFIGURATION =head1 CONFIGURATION
This shows the default configuration of this plugin. You can override This shows the default configuration of this plugin. You can override
the log file path and the logpattern. the log file path and the logpattern.
Additionally you may want to adjust 'group' (or 'user') based on the
permissions required for reading the log file.
[nginx_error] [nginx_error]
group adm
env.logpath /var/log/nginx env.logpath /var/log/nginx
env.logpattern a.*.log env.logpattern a.*.log
Nginx must also be configured to log accesses in "combined" log format (default) Nginx must also be configured to log accesses in "combined" log format (default)
=head1 USAGE =head1 USAGE
Link this plugin to /etc/munin/plugins/ and restart the munin-node. Link this plugin to /etc/munin/plugins/ and restart the munin-node.
@ -33,19 +39,25 @@ will parse the log file /var/log/nginx/a.mydomaincom.log
You can change 'env.logpattern' using asterisk ('*') to match your logs filenames. You can change 'env.logpattern' using asterisk ('*') to match your logs filenames.
'env.logpattern' is ignored for a non-symlink configuration.
=head1 INTERPRETATION =head1 INTERPRETATION
The plugin shows nginx http "error" status rates by parsing access log. The plugin shows nginx http "error" status rates by parsing access log.
=head1 MAGIC MARKERS =head1 MAGIC MARKERS
#%# family=auto #%# family=auto
#%# capabilities=autoconf #%# capabilities=autoconf
=head1 BUGS =head1 BUGS
None known. None known.
=head1 VERSION =head1 VERSION
1.1 - 2018/01/20 1.1 - 2018/01/20
@ -60,6 +72,7 @@ None known.
vovansystems@gmail.com, 2013 vovansystems@gmail.com, 2013
=head1 LICENSE =head1 LICENSE
GPLv3 GPLv3
@ -122,7 +135,7 @@ do_config () {
echo "graph_vlabel pages with http error codes / \${graph_period}" echo "graph_vlabel pages with http error codes / \${graph_period}"
echo "graph_category webserver" echo "graph_category webserver"
echo "graph_period minute" echo "graph_period minute"
echo "graph_info This graph shows nginx error amount per minute" echo "graph_info This graph shows nginx error rate per minute"
for status_code in "${!http_codes[@]}"; do for status_code in "${!http_codes[@]}"; do
echo "error${status_code}.type DERIVE" echo "error${status_code}.type DERIVE"
echo "error${status_code}.min 0" echo "error${status_code}.min 0"