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
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Nagios Plugin API</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<meta name="keywords" content="Supervision, Icinga, Icinga, Linux">
<link rel="home" href="index.html" title="Icinga Version 1.0.2 Dokumentation">
<link rel="up" href="ch10.html" title="Kapitel 10. Entwicklung">
<link rel="prev" href="ch10.html" title="Kapitel 10. Entwicklung">
<link rel="next" href="epnplugins.html" title="Entwickeln von Plugins für die Nutzung mit Embedded Perl">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<CENTER><IMG src="../images/logofullsize.png" border="0" alt="Icinga" title="Icinga"></CENTER>
<div class="navheader">
<table width="100%" summary="Navigation header">
<tr><th colspan="3" align="center">Nagios Plugin API</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="ch10.html">Zurück</a> </td>
<th width="60%" align="center">Kapitel 10. Entwicklung</th>
<td width="20%" align="right"> <a accesskey="n" href="epnplugins.html">Weiter</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="section" title="Nagios Plugin API">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="pluginapi"></a>Nagios Plugin API</h2></div></div></div>
<p><span class="bold"><strong>Andere Ressourcen</strong></span></p>
<p>Wenn Sie planen, Ihren eigenen Plugins für Icinga zu schreiben, dann besuchen Sie folgende Ressourcen:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>Die offizielle <a class="link" href="http://sourceforge.net/projects/nagiosplug/" target="_top">Nagios-Plugin-Projekt-Website</a></p>
</li>
<li class="listitem">
<p>Die offiziellen <a class="link" href="http://nagiosplug.sourceforge.net/developer-guidelines.html" target="_top">Nagios-Plugin-Entwicklungsrichtlinien</a></p>
</li>
</ul></div>
<p><span class="bold"><strong>Plugin-Überblick</strong></span></p>
<p>Scripts und ausführbare Programme müssen (mindestens) zwei Dinge tun, um als Icinga-Plugins zu
funktionieren:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>mit einem von verschiedenen möglichen Return-Codes enden</p>
</li>
<li class="listitem">
<p>mindestens eine Zeile Textausgabe an STDOUT zurückliefern</p>
</li>
</ul></div>
<p>Die inneren Abläufe Ihres Plugins sind für Icinga unwichtig. Ihr Plugin könnte den Zustand eines TCP-Ports prüfen,
eine Datenbankabfrage durchführen, den freien Plattenplatz ermitteln oder was immer benötigt wird, um etwas zu prüfen. Die
Einzelheiten hängen davon ab, was zu prüfen ist - das liegt an Ihnen.</p>
<p><span class="bold"><strong>Return-Code</strong></span></p>
<p>Icinga ermittelt den Zustand eines Hosts oder Service über die Auswertung des Return-Codes des Plugins. Die
folgenden Tabellen zeigen eine Liste von gültigen Return-Codes zusammen mit ihren entsprechenden Service- oder
Host-Zuständen.</p>
<div class="informaltable">
<table border="1">
<colgroup>
<col>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td><p> <span class="bold"><strong>Plugin Return-Code</strong></span> </p></td>
<td><p> <span class="bold"><strong>Service-Zustand</strong></span> </p></td>
<td><p> <span class="bold"><strong>Host-Zustand</strong></span> </p></td>
</tr>
<tr>
<td><p>0</p></td>
<td><p>OK</p></td>
<td><p>UP</p></td>
</tr>
<tr>
<td><p>1</p></td>
<td><p>WARNING</p></td>
<td><p>UP oder DOWN/UNREACHABLE*</p></td>
</tr>
<tr>
<td><p>2</p></td>
<td><p>CRITICAL</p></td>
<td><p>DOWN/UNREACHABLE</p></td>
</tr>
<tr>
<td><p>3</p></td>
<td><p>UNKNOWN</p></td>
<td><p>DOWN/UNREACHABLE</p></td>
</tr>
</tbody>
</table>
</div>
<p><span class="inlinemediaobject"><img src="../images/note.gif"></span> Anmerkung: Wenn die <a class="link" href="configmain.html#configmain-use_aggressive_host_checking">use_aggressive_host_checking</a>-Option aktiviert ist, dann ergibt ein
Return-Code von 1 einen Host-Zustand "DOWN" oder "UNREACHABLE". Andernfalls ergibt ein Return-Code von 1 einen Host-Zustand
"UP". Der Prozess, durch den Icinga ermittelt, ob ein Host DOWN oder UNREACHABLE ist, wird <a class="link" href="networkreachability.html" title="Ermitteln des Zustands und der Erreichbarkeit von Netzwerk-Hosts">hier</a> erklärt.</p>
<p><span class="bold"><strong>Spezifikation der Plugin-Ausgabe(n)</strong></span></p>
<p>Als Minimum sollten Plugins mindestens eine Zeile Textausgabe zurückliefern, es können aber auch mehrere Zeilen Ausgaben
sein. Plugins können zusätzlich Performance-Daten zurückliefern, die von externen Applikationen verarbeitet werden können. Das
grundlegende Format für Plugin-Ausgaben ist wie folgt:</p>
<p><span class="color">TEXT OUTPUT</span> | <span class="color">OPTIONAL
PERFDATA</span></p>
<p><span class="color">LONG TEXT LINE 1 LONG TEXT LINE 2 ... LONG TEXT LINE N</span> | <span class="color">PERFDATA LINE 2</span></p>
<p><span class="color">PERFDATA LINE 3 ... PERFDATA LINE N</span></p>
<p>Die Performance-Daten (in <span class="color">orange</span> dargestellt) sind optional. Wenn
ein Plugin Performance-Daten in der Ausgabe zurückliefert, dann müssen die Performance-Daten von den anderen Textausgaben mit
einem Pipe-Symbol (|) getrennt werden. Zusätzliche Zeilen von langen Textausgaben (in <span class="color">blau</span> dargestellt) sind ebenso optional.</p>
<p><span class="bold"><strong>Plugin-Beispielausgaben</strong></span></p>
<p>Nun ein paar Beispiele von möglichen Plugin-Ausgaben...</p>
<p><span class="bold"><strong>Fall 1: Eine Zeile Ausgabe (nur Text)</strong></span></p>
<p>Angenommen, wir haben ein Plugin, das eine Zeile ausgibt, dann sieht das wie folgt aus:</p>
<p>DISK OK - free space: / 3326 MB (56%); Wenn dieses Plugin benutzt wurde, um eine Service-Prüfung durchzuführen, wird die
gesamte Zeile der Ausgabe im <a class="link" href="macrolist.html#macrolist-serviceoutput">$SERVICEOUTPUT$</a>-Makro gespeichert.</p>
<p><span class="bold"><strong>Fall 2: Eine Zeile Ausgabe (Text und Performance-Daten)</strong></span></p>
<p>Ein Plugin kann optionale Performance-Daten zurückliefern, die von externen Applikationen benutzt werden. Um dies zu tun,
müssen die Performance-Daten von der Textausgabe durch ein Pipe-Symbol (|) wie folgt getrennt werden:</p>
<p>DISK OK - free space: / 3326 MB (56%); | /=2643MB;5948;5958;0;5968Wenn dieses Plugin benutzt wurde, um eine
Service-Prüfung durchzuführen, wird der rote Teil der Ausgabe (links vom Pipe-Symbol) im <a class="link" href="macrolist.html#macrolist-serviceoutput">$SERVICEOUTPUT$</a>-Makro und der orange Teil der Ausgabe (rechts vom Pipe-Symbol) im
<a class="link" href="macrolist.html#macrolist-serviceperfdata">$SERVICEPERFDATA$</a>-Makro gespeichert. <span class="bold"><strong>Fall 3: Mehrere
Zeilen Ausgaben (Text und Performance-Daten)</strong></span></p>
<p>Ein Plugin kann optional mehrere Zeilen von Text und Perforance-Daten wie folgt zurückliefern:</p>
<p><span class="color">DISK OK - free space: / 3326 MB (56%);</span></p>
<p> | <span class="color">/=2643MB;5948;5958;0;5968</span></p>
<p><span class="color">/ 15272 MB (77%);</span></p>
<p><span class="color">/boot 68 MB (69%);</span></p>
<p><span class="color">/home 69357 MB (27%);</span></p>
<p><span class="color">/var/log 819 MB (84%);</span> | <span class="color">/boot=68MB;88;93;0;98</span></p>
<p><span class="color">/home=69357MB;253404;253409;0;253414</span></p>
<p><span class="color">/var/log=818MB;970;975;0;980</span></p>
<p>Wenn dieses Plugin benutzt wurde, um eine Service-Prüfung durchzuführen, wird der <span class="color">rote</span> Teil der ersten Zeile der Ausgabe (links vom Pipe-Symbol) im <a class="link" href="macrolist.html#macrolist-serviceoutput">$SERVICEOUTPUT$</a>-Makro gespeichert. Der <span class="color">orange</span> Teil der ersten und folgender Zeilen wird (durch Leerzeichen verbunden) im <a class="link" href="macrolist.html#macrolist-serviceperfdata">$SERVICEPERFDATA$</a>-Makro gespeichert. Der <span class="color">blaue</span> Teil der zweiten bis fünften Zeile der Ausgabe wird (mit maskierten Newlines) verkettet und im
<a class="link" href="macrolist.html#macrolist-longserviceoutput">$LONGSERVICEOUTPUT$</a>-Makro gespeichert.</p>
<p>Der endgültige Inhalt jedes Makros ist wie folgt:</p>
<div class="informaltable">
<table border="1">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td><p> <span class="bold"><strong>Makro</strong></span> </p></td>
<td><p> <span class="bold"><strong>Wert</strong></span> </p></td>
</tr>
<tr>
<td><p>$SERVICEOUTPUT$</p></td>
<td><p> <span class="color">DISK OK - free space: / 3326 MB (56%);</span> </p></td>
</tr>
<tr>
<td><p>$SERVICEPERFDATA$</p></td>
<td><p> <span class="color">/=2643MB;5948;5958;0;5968 /boot=68MB;88;93;0;98 /home=69357MB;253404;253409;0;253414 /var/log=818MB;970;975;0;980</span>
</p></td>
</tr>
<tr>
<td><p>$LONGSERVICEOUTPUT$</p></td>
<td><p> <span class="color">/ 15272 MB (77%);\n/boot 68 MB (69%);\n/var/log 819 MB
(84%);</span> </p></td>
</tr>
</tbody>
</table>
</div>
<p>Mit Blick auf mehrere Zeilen Ausgaben haben Sie die folgenden Möglichkeiten, Performance-Daten zurückzuliefern:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>Sie können keinerlei Performance-Daten zurückliefern</p>
</li>
<li class="listitem">
<p>Sie können nur in der ersten Zeile Performance-Daten zurückliefern</p>
</li>
<li class="listitem">
<p>Sie können Performance-Daten in nachfolgenden Zeilen zurückliefern (nach der ersten)</p>
</li>
<li class="listitem">
<p>Sie können Performance-Daten in der ersten und folgenden Zeilen zurückliefern (wie oben gezeigt)</p>
</li>
</ul></div>
<p><span class="bold"><strong>Längenbeschränkungen von Plugin-Ausgaben</strong></span></p>
<p>Icinga wird nur die ersten vier KB an Daten lesen, die ein Plugin zurückliefert. Dies wird getan, um durchgedrehte
Plugins davon abzuhalten, Megabyte oder Gigabyte an Daten an Icinga zurückzuliefern. Diese Beschränkung von vier KB kann
einfach geändert werden, wenn Sie das brauchen. Ändern Sie einfach den Wert der MAX_PLUGIN_OUTPUT_LENGTH-Definition in der
<span class="emphasis"><em>include/nagios.h.in</em></span>-Datei der Source-Code-Distribution und rekompilieren Sie Icinga. Mehr müssen Sie
nicht tun!</p>
<p><span class="bold"><strong>Beispiele</strong></span></p>
<p>Wenn Sie nach Beispiel-Plugins suchen, um sie zu studieren, würden wir empfehlen, dass Sie die offiziellen
Icinga-Plugins herunterladen und den Code von verschiedenen C-, Perl- und Shell-Script-Plugins ansehen. Informationen,
wie Sie die offiziellen Plugins besorgen können, finden Sie <a class="link" href="plugins.html" title="Icinga Plugins">hier</a>.</p>
<p><span class="bold"><strong>Perl-Plugins</strong></span></p>
<p>Icinga bietet einen optionalen <a class="link" href="embeddedperl.html" title="Benutzen des Embedded Perl Interpreters">eingebauten Perl-Interpreter</a> (embedded Perl
interpreter), der die Ausführung von Perl-Plugins beschleunigen kann. Mehr Informationen zur Entwicklung von Perl-Plugins zur
Nutzung mit dem eingebauten Perl-Interpreter finden Sie <a class="link" href="embeddedperl.html" title="Benutzen des Embedded Perl Interpreters">hier</a>.</p>
<a class="indexterm" name="id5613226"></a>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="ch10.html">Zurück</a> </td>
<td width="20%" align="center"><a accesskey="u" href="ch10.html">Nach oben</a></td>
<td width="40%" align="right"> <a accesskey="n" href="epnplugins.html">Weiter</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Kapitel 10. Entwicklung </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td>
<td width="40%" align="right" valign="top"> Entwickeln von Plugins für die Nutzung mit Embedded Perl</td>
</tr>
</table>
</div>
<P class="copyright">© 2009-2010 Icinga Development Team, http://www.icinga.org</P>
</body>
</html>
|
