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
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
|
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>Entwickeln von Plugins für die Nutzung mit Embedded Perl</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="pluginapi.html" title="Nagios Plugin API">
<link rel="next" href="icinga-web-scratch.html" title="Installation des neuen Icinga Web Frontend">
</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">Entwickeln von Plugins für die Nutzung mit Embedded Perl</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="pluginapi.html">Zurück</a> </td>
<th width="60%" align="center">Kapitel 10. Entwicklung</th>
<td width="20%" align="right"> <a accesskey="n" href="icinga-web-scratch.html">Weiter</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="section" title="Entwickeln von Plugins für die Nutzung mit Embedded Perl">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="epnplugins"></a>Entwickeln von Plugins für die Nutzung mit Embedded Perl</h2></div></div></div>
<p><span class="bold"><strong>Einführung</strong></span></p>
<p>Stanley Hopcroft hat ziemlich viel mit dem eingebetten Perl-Interpreter gearbeitet und die Vor- und Nachteile der Nutzung
kommentiert. Er hat auch verschiedene Hinweise gegeben, um Perl-Plugins zu erstellen, die sauber mit dem eingebetteten
Interpreter laufen. Der überwiegende Teil dieser Dokumentation stammt aus seinen Kommentaren.</p>
<p>Es ist anzumerken, dass sich "ePN", wie in dieser Dokumentation verwendet, auf den eingebetteten Perl-Interpreter, oder
wenn Ihnen das lieber ist, auf Icinga kompiliert mit einem eingebetteten Perl-Interpreter bezieht.</p>
<p><span class="bold"><strong>Zielgruppe</strong></span></p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>Durchschnittliche Perl-Entwickler mit einem Verständnis für die mächtigen Eigenschaften der Sprache ohne Wissen der
Interna bzw. einem vertieften Wissen dieser Eigenschaften.</p>
</li>
<li class="listitem">
<p>die mit einem benutzenden Wissen statt einem tiefen Verständnis</p>
</li>
<li class="listitem">
<p>wenn Sie glücklich sind mit Perl-Objekten, sprich Verwaltung, Datenstrukturen und dem Debugger, dann ist das
wahrscheinlich ausreichend.</p>
</li>
</ul></div>
<p><span class="bold"><strong>Dinge, die Sie tun sollten, wenn Sie ein Perl-Plugin entwickeln (mit ePN oder
ohne)</strong></span></p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>generieren Sie immer etwas Output</p>
</li>
<li class="listitem">
<p>Verwenden Sie 'use utils' und importieren Sie die Dinge, die es exportiert ($TIMEOUT %ERRORS &print_revision
&support)</p>
</li>
<li class="listitem">
<p>Werfen Sie einen Blick darauf, wie die Standard-Plugins ihren Kram erledigen</p>
<div class="itemizedlist"><ul class="itemizedlist" type="circle">
<li class="listitem">
<p>beenden Sie immer mit $ERRORS{CRITICAL}, $ERRORS{OK}, etc.</p>
</li>
<li class="listitem">
<p>verwenden Sie getopt, um Kommandozeilenparameter einzulesen</p>
</li>
<li class="listitem">
<p>denken Sie an Timeout-Verwaltung</p>
</li>
<li class="listitem">
<p>rufen Sie print_usage auf (das Sie liefern müssen), wenn keine Kommandozeilenparameter übergeben wurden</p>
</li>
<li class="listitem">
<p>benutzen Sie Standard-Optionen (eg H 'host', V 'version')</p>
</li>
</ul></div>
</li>
</ul></div>
<p><span class="bold"><strong>Dinge, die Sie tun müssen, um ein Perl-Plugin für ePN zu entwickeln</strong></span></p>
<div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
<p><DATA> kann nicht verwendet werden, benutzen Sie statt dessen here-Dokumente, z.B.</p>
<pre class="screen">my $data = <<DATA;
portmapper 100000
portmap 100000
sunrpc 100000
rpcbind 100000
rstatd 100001
rstat 100001
rup 100001
..
DATA
%prognum = map { my($a, $b) = split; ($a, $b) } split(/\n/, $data) ;</pre>
</li>
<li class="listitem">
<p>BEGIN-Blöcke werden nicht so funktionieren, wie Sie das erwarten. Es wird das Beste sein, wenn Sie darauf
verzichten.</p>
</li>
<li class="listitem">
<p>stellen Sie sicher, dass es während des Compile absolut sauber ist, d.h.</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>use strict</p>
</li>
<li class="listitem">
<p>use perl -w (andere Switches [namentlich T] könnten nicht weiterhelfen)</p>
</li>
<li class="listitem">
<p>use perl -c</p>
</li>
</ul></div>
</li>
<li class="listitem">
<p>Vermeiden Sie lexikalische Variablen (my) mit globalem Geltungsbereich, um damit __variable__ Daten in Unterroutinen
zu übergeben. Das ist in der Tat __fatal__, wenn die Unterroutine mehrfach aufgerufen wird, während die Prüfung läuft.
Solche Unterroutinen arbeiten als 'closures', die den ersten Wert der globalen lexikalischen Variable bei folgenden Aufrufen
der Unterroutine beibehalten. Wenn die globale Variable allerdings read-only ist (bei einer komplizierten Struktur zum
Beispiel), dann ist das kein Problem. Was Bekman <a class="link" href="http://perl.apache.org/docs/1.0/guide/" target="_top">Ihnen statt
dessen rät</a>, ist eines der folgenden Dinge:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>machen Sie die Unterroutine anonym und rufen Sie sie z.B. über eine Code-Referenz auf</p>
<pre class="screen">ändern Sie dies in
my $x = 1 ; my $x = 1 ;
sub a { .. Process $x ... } $a_cr = sub { ... Process $x ... } ;
. .
. .
a ; &$a_cr ;
$x = 2 $x = 2 ;
a ; &$a_cr ;
# anonyme Closures binden __immer__ den aktuellen lexikalischen Wert ein</pre>
</li>
<li class="listitem">
<p>packen Sie globale Lexikale und die Unterroutine, die sie benutzt, in ihr eigenes Package (als ein Objekt oder
Modul)</p>
</li>
<li class="listitem">
<p>übergeben Sie Informationen an Unterroutinen als Referenzen oder Aliases (\$lex_var oder $_[n])</p>
</li>
<li class="listitem">
<p>ersetzen Sie Lexikale durch Package Globals und schließen Sie diese von 'use strict'-Beanstandungen durch 'use
vars qw(global1 global2 ..)' aus</p>
</li>
</ul></div>
</li>
<li class="listitem">
<p>Seien Sie sich bewusst, woher Sie mehr Informationen bekommen können.</p>
<p>Nützliche Informationen können Sie von den üblichen Verdächtigen bekommen (die O'Reilly-B�cher, plus Damien Conways
"Object Oriented Perl"), aber um den wirklich nützlichen Kram im richtigen Kontext zu bekommen, starten Sie mit Stas
Bekman's mod_perl guide unter <a class="link" href="http://perl.apache.org/guide/" target="_top">http://perl.apache.org/guide/</a>.</p>
<p>Dieses wundervolle Dokument in Buchgröße hat überhaupt nichts mit Icinga zu tun, aber dafür umso mehr mit dem
Schreiben von Perl-Programmen für den eingebetteten Perl-Interpreter in Apache (d.h. Doug MacEacherns
mod_perl).</p>
<p>Die perlembed-Manpage ist wichtig für den Zusammenhang und die Ermunterung..</p>
<p>Auf der Basis, dass Lincoln Stein und Doug MacEachern ein oder zwei Dinge über Perl und eingebettetes Perl wissen, ist
ihr Buch 'Writing Apache Modules with Perl and C' ziemlich sicher einen Blick wert.</p>
</li>
<li class="listitem">
<p>Achten Sie darauf, dass Ihr Plugin mit ePN vielleicht merkwürdige Werte zurückliefert und dass das wahrscheinlich an
dem unter Punkt 4 angesprochenen Problem liegt</p>
</li>
<li class="listitem">
<p>Seien Sie darauf vorbereitet, dass Sie debuggen über:</p>
<div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
<p>ein Test-ePN und</p>
</li>
<li class="listitem">
<p>print-Befehle in Ihr Plugin einfügen, um Variablenwerte auf STDERR auszugeben (da Sie STDOUT nicht verwenden
können)</p>
</li>
<li class="listitem">
<p>print-Befehle in p1.pl einfügen, um anzuzeigen, was ePN glaubt, was Ihr Plugin ist, bevor es versucht, das
auszuführen (vi)</p>
</li>
<li class="listitem">
<p>ePN im Vordergrund-Modus auszuführen (möglicherweise in Verbindung mit den obigen Empfehlungen)</p>
</li>
<li class="listitem">
<p>das 'Deparse#-Modul in Ihrem Modul zu benutzen, um zu sehen, wie der Parser es optimiert hat und was der
Interpreter wirklich bekommt (lesen Sie 'Constants in Perl' von Sean M. Burke, The Perl Journal, Fall 2001)</p>
</li>
</ul></div>
<pre class="screen"> perl -MO::Deparse <your_program></pre>
</li>
<li class="listitem">
<p>Beachten Sie, in was ePN Ihr Plugin transformiert, und falls alles andere fehlschlägt, debuggen Sie die transformierte
Version.</p>
<p>Wie Sie unten sehen können, schreibt p1.pl Ihr Plugin um in eine Unterroutine namens 'hndlr' im Package
'Embed::<something_related_to_your_plugin_file_name>'.</p>
<p>Ihr Plugin wird ggf. Kommandozeilenparameter in @ARGV erwarten, so dass p1.pl auch @_ an @ARGV zuweist.</p>
<p>Dies wiederum wird 'eval'-t und falls dieser Test mit einem Fehler fehlschlägt (jeder Parse- oder Laufzeitfehler),
wird das Plugin 'rausgeschmissen'.</p>
<p>Die folgenden Ausgaben zeigen, wie ein Test-ePN das <span class="emphasis"><em>check_rpc</em></span>-Plugin transformiert hat, bevor es
versucht, es auszuführen. Der meiste Code des eigentlichen Plugins wird nicht gezeigt, weil wir nur an den Umformungen
interessiert sind, die der ePN am Plugin vorgenommen hat). Zur Verdeutlichung sind die Umformungen in rot
dargestellt:</p>
<pre class="screen"> package main;
use subs 'CORE::GLOBAL::exit';
sub CORE::GLOBAL::exit { die "ExitTrap: $_[0] (Embed::check_5frpc)"; }
package Embed::check_5frpc; sub hndlr { shift(@_);
@ARGV=@_;
#! /usr/bin/perl -w
#
# check_rpc plugin for Icinga
#
# usage:
# check_rpc host service
#
# Check if an rpc service is registered and running
# using rpcinfo - $proto $host $prognum 2>&1 |";
#
# Use these hosts.cfg entries as examples
#
# command[check_nfs]=/some/path/libexec/check_rpc $HOSTADDRESS$ nfs
# service[check_nfs]=NFS;24x7;3;5;5;unix-admin;60;24x7;1;1;1;;check_rpc
#
# initial version: 3 May 2000 by Truongchinh Nguyen and Karl DeBisschop
# current status: $Revision: 1.18 $
#
# Copyright Notice: GPL
#
<span class="emphasis"><em> ... der Rest des Plugin-Codes folgt (und wurde aus Gründen der Kürze entfernt) ...</em></span>
}</pre>
</li>
<li class="listitem">
<p>Nutzen Sie 'use diagnostics' nicht in einem produktiven ePN. Wir glauben, es sorgt dafür, dass __alle__ Perl-Plugins
CRITICAL zurückliefern.</p>
</li>
<li class="listitem">
<p>Überlegen Sie, ob Sie ein Mini-ePN benutzen, um Ihr Plugin zu testen. Das ist nicht ausreichend, um zu garantieren,
dass Ihr Plugin mit einem ePN fehlerfrei ausgeführt wird, aber wenn bereits der Plugin-Test fehlschlägt, dann wird er auf
jeden Fall mit Ihrem ePN fehlschlagen. <span class="color">[ Ein Beispiel-Mini-ePN ist im
<span class="emphasis"><em>contrib/</em></span>-Verzeichnis der Icinga-Distribution zu finden. Wechseln Sie in das contrib/-Verzeichnis
und tippen Sie 'make mini_epn', um es zu kompilieren. Es muss im gleichen Verzeichnis ausgeführt werden, in dem die
p1.pl-Datei steht (diese Datei wird mit Icinga ausgeliefert). ]</span></p>
</li>
</ol></div>
<a class="indexterm" name="id5613684"></a>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="pluginapi.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="icinga-web-scratch.html">Weiter</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Nagios Plugin API </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td>
<td width="40%" align="right" valign="top"> Installation des neuen Icinga Web Frontend</td>
</tr>
</table>
</div>
<P class="copyright">© 2009-2010 Icinga Development Team, http://www.icinga.org</P>
</body>
</html>
|
