Robot
/
contrib-munin
mirror of https://github.com/munin-monitoring/contrib.git
2
0
Fork 0
Code Issues Releases Wiki Activity

Update README.pod

This commit is contained in:
Alex Mestiashvili 2016-12-06 18:42:20 +01:00
parent 9c29d49666
commit 06c8538aa1
1 changed files with 44 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

52
tools/munin2snmp/README.pod
View File

@ -4,7 +4,7 @@ munin2snmp - SNMP Agent to query munin-node over snmp
=head1 REQUIREMENTS
Net::SNMP and IO::Socket perl modules, munin-node with some plugins
Net::SNMP, Getopt::Long, Pod::Usage perl modules, munin-node with some plugins
=head2 Example configuration
@ -22,12 +22,28 @@ or another place where snmpd expects to find the MIB files.
See also http://www.net-snmp.org/wiki/index.php/FAQ:MIBs_03
It is possible to start munin2snmp as non-root user, for example
run munin2snmp as Debian-snmp user on Debian Stretch:
fix the /var/agentx permissions:
chmod g+rx /var/agentx
chgrp Debian-snmp /var/agentx
add to /etc/snmp/snmpd.conf:
master agentx
agentXperms 0640 0550 Debian-snmp Debian-snmp
restart snmpd and start the agent as Debian-snmp:
su -l Debian-snmp -s /bin/bash -c "/tmp/munin2snmp.pl --pidfile /tmp/munin2snmp.pid --plugins iostat,vmstat"
=head2 Usage
After setting up snmpd, start the agent:
./munin2snmp.pl
./munin2snmp
Now one can query the agent
@ -36,6 +52,8 @@ Now one can query the agent
where "1.3.6.1.4.1.123456.100.1.1" is example OID selected as the base
tree for the agent.
Change OBJECT IDENTIFIER in the MUNIN-MIB file if you plan to use a different OID.
You might need to change the host, port, oidbase and munin_plugins you want to use.
The defaults:
@ -43,7 +61,17 @@ The defaults:
$Munin{PORT} = '4949';
$Munin{HOST} = 'localhost'
$oidbase = ".1.3.6.1.4.1.123456.100.1.1"
@munin_plugins = qw ( load swap users uptime vmstat df );
@munin_plugins = qw ( load cpu df );
One can override the defaults by creating /etc/munin2snmp.conf file with the following
configuration options:
munin_port = [port]
munin_host = [host]
base_oid = [oid]
munin_plugins = [comma separated list of munin-node plugins]
Or by specifying the parameters, see munin2snmp --help for the usage
=head1 ACKNOWLEDGEMENTS
@ -51,12 +79,20 @@ Heavily inspired by
Vincent Bernat: https://github.com/vincentbernat/extend-netsnmp
and Masahito Zembutsu: https://github.com/zembutsu/muninwalk
=head1 AUTHOR
Alex Mestiashvili <mailatgoogl@gmail.com>
=head1 LICENSE
GPLv2
ISC License (ISC)
Copyright (c) 2016, Alex Mestiashvili <mailatgoogl@gmail.com>
Permission to use, copy, modify, and/or distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.
THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.