|
1 # Arborist-SNMP |
|
2 |
|
3 home |
|
4 : http://bitbucket.org/mahlon/Arborist-SNMP |
|
5 |
|
6 code |
|
7 : http://code.martini.nu/Arborist-SNMP |
|
8 |
|
9 |
|
10 ## Description |
|
11 |
|
12 Arborist is a monitoring toolkit that follows the UNIX philosophy |
|
13 of small parts and loose coupling for stability, reliability, and |
|
14 customizability. |
|
15 |
|
16 This adds SNMP support to Arborist's monitoring, for things such as: |
|
17 |
|
18 - Disk space capacity |
|
19 - System load |
|
20 - Free memory |
|
21 - Swap in use |
|
22 - Running process checks |
|
23 |
|
24 |
|
25 ## Prerequisites |
|
26 |
|
27 * Ruby 2.2 or better |
|
28 |
|
29 |
|
30 ## Installation |
|
31 |
|
32 $ gem install arborist-snmp |
|
33 |
|
34 |
|
35 ## Usage |
|
36 |
|
37 In this example, we've created a resource node under an existing host, like so: |
|
38 |
|
39 Arborist::Host( 'example' ) do |
|
40 description "Example host" |
|
41 address '10.6.0.169' |
|
42 resource 'load', description: 'machine load' |
|
43 end |
|
44 |
|
45 |
|
46 From a monitor file, require this library, and create an snmp instance. |
|
47 You can reuse a single instance, or create individual ones per monitor. |
|
48 |
|
49 |
|
50 require 'arborist/monitor/snmp' |
|
51 |
|
52 Arborist::Monitor '5 minute load average check' do |
|
53 every 30.seconds |
|
54 match type: 'resource', category: 'load' |
|
55 include_down true |
|
56 use :addresses |
|
57 |
|
58 snmp = Arborist::Monitor::SNMP.new( mode: 'load', load_error_at: 10 ) |
|
59 exec( snmp ) |
|
60 end |
|
61 |
|
62 Please see the rdoc for all the mode types and error_at options. |
|
63 |
|
64 |
|
65 ## License |
|
66 |
|
67 Copyright (c) 2016, Michael Granger and Mahlon E. Smith |
|
68 All rights reserved. |
|
69 |
|
70 Redistribution and use in source and binary forms, with or without |
|
71 modification, are permitted provided that the following conditions are met: |
|
72 |
|
73 * Redistributions of source code must retain the above copyright notice, |
|
74 this list of conditions and the following disclaimer. |
|
75 |
|
76 * Redistributions in binary form must reproduce the above copyright notice, |
|
77 this list of conditions and the following disclaimer in the documentation |
|
78 and/or other materials provided with the distribution. |
|
79 |
|
80 * Neither the name of the author/s, nor the names of the project's |
|
81 contributors may be used to endorse or promote products derived from this |
|
82 software without specific prior written permission. |
|
83 |
|
84 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
|
85 AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
|
86 IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE |
|
87 DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE |
|
88 FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL |
|
89 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR |
|
90 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER |
|
91 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, |
|
92 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
|
93 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
|
94 |
|
95 |