1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
|
# Copyright (C) 2010 Stanislav Sinyagin
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307, USA.
# $Id: torrus_snmpfailures.pod.in,v 1.1 2010-12-27 00:04:37 ivan Exp $
# Stanislav Sinyagin <ssinyagin@yahoo.com>
#
#
=head1 NAME
snmpfailures - Displays SNMP collector failures.
=head1 SYNOPSIS
B<torrus snmpfailures> --tree=I<TREENAME> [I<options...>]
=head1 OPTIONS
=over 4
=item B<--details>
In addition to failure counters, list the failed SNMP hosts and the time
stamps of failure events.
=item B<--help>
Displays a help message.
=back
=head1 DESCRIPTION
This utility prints the SNMP collector failure information in JSON format.
Without B<--details> option, it prints only the failure counters.
Upon collector startup or after the tree re-compilation, the failure
counters are reset to zero.
The output is very convenient for further automatic processing in any
scripting language.
The top level of the output is a JSON object with the following name/value
pairs:
=over 4
=item B<total_unreachable>: NUMBER
Displays the number SNMP hosts that are currently unreachable.
The number adds up across multiple collector instances for a given tree.
If a host becomes reachable again, the number is decreased.
=item B<total_deleted>: NUMBER
Displays the number SNMP hosts that are completely removed from SNMP
collection for the life cycle of the collector process. This happens when
a host is unreachable for too long time and the collector gives up
to reach it again.
The number adds up across multiple collector instances for a given tree.
=item B<total_mib_errors>: NUMBER
Displays the number of MIB errors (I<noSuchObject>, I<noSuchInstance>,
and I<endOfMibView>) during the collector life cycle.
The number adds up across multiple collector instances for a given tree.
=item B<detail_unreachable>: OBJECT, B<detail_deleted>: OBJECT
If the option B<--details> is specified, these objects contain the host names
and timestamps of the failures.
The keys are contactenations of SNMP host, UDP port, and SNMP
community separated by "|".
The values are objects representing the UNIX timestamp and a human-readable
time string.
=item B<detail_mib_errors>: OBJECT
If the option B<--details> is specified, this object displays the MIB error
details: for each SNMP host, it lists the datasource leaves which had these
errors and the event timestamps.
=back
=head1 EXAMPLES
The following example illustrates an SNMP host unreachable:
torrus failures --tree=main --details
{
"detail_deleted" : {},
"detail_mib_errors" : {},
"detail_unreachable" : {
"217.101.101.101|161|public" : {
"time" : "Fri Jul 23 14:15:10 2010",
"timestamp" : 1279887310
}
},
"total_deleted" : 0,
"total_mib_errors" : 0,
"total_unreachable" : 1
}
The following example illustrates a MIB error:
torrus failures --tree=main --details
{
"detail_deleted" : {},
"detail_mib_errors" : {
"217.101.102.102|161|public" : {
"count" : 1,
"nodes" : {
"/Routers/CMTS3/Temperature_Sensors/sensor_01" : {
"time" : "Fri Jul 23 15:26:14 2010",
"timestamp" : 1279891574
}
}
}
},
"detail_unreachable" : {},
"total_deleted" : 0,
"total_mib_errors" : 1,
"total_unreachable" : 0
}
=head1 SEE ALSO
L<torrus(@mansec_usercmd@)>,
=head1 NOTES
See more documentation at Torrus home page: http://torrus.org
=head1 AUTHOR
Stanislav Sinyagin E<lt>ssinyagin@yahoo.comE<gt>
|
