File: plugins.html

package info (click to toggle)
icinga 1.14.2%2Bds-3
  • links: PTS, VCS
  • area: main
  • in suites: buster
  • size: 49,264 kB
  • sloc: ansic: 108,564; sql: 9,656; sh: 4,945; perl: 3,439; makefile: 1,213; php: 581; xml: 104
file content (661 lines) | stat: -rw-r--r-- 34,436 bytes parent folder | download
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
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<title>5.1. Icinga Plugins</title>
<link rel="stylesheet" href="../stylesheets/icinga-docs.css" type="text/css">
<meta name="generator" content="DocBook XSL Stylesheets V1.75.1">
<meta name="keywords" content="Supervision, Icinga, Nagios, Linux">
<link rel="home" href="index.html" title="Icinga Version 1.14 Dokumentation">
<link rel="up" href="ch05.html" title="Kapitel 5. Die Grundlagen">
<link rel="prev" href="ch05.html" title="Kapitel 5. Die Grundlagen">
<link rel="next" href="macros.html" title="5.2. Makros verstehen und wie sie arbeiten">
<script src="../js/jquery-min.js" type="text/javascript"></script><script src="../js/icinga-docs.js" type="text/javascript"></script>
</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">5.1. Icinga Plugins</th></tr>
<tr>
<td width="20%" align="left">
<a accesskey="p" href="ch05.html">Zurück</a> </td>
<th width="60%" align="center">Kapitel 5. Die Grundlagen</th>
<td width="20%" align="right"> <a accesskey="n" href="macros.html">Weiter</a>
</td>
</tr>
</table>
<hr>
</div>
<div class="section" title="5.1. Icinga Plugins">
<div class="titlepage"><div><div><h2 class="title" style="clear: both">
<a name="plugins"></a>5.1. Icinga Plugins</h2></div></div></div>
<div class="toc"><dl>
<dt><span class="section">5.1.1. <a href="plugins.html#introduction">Einführung</a></span></dt>
<dt><span class="section">5.1.2. <a href="plugins.html#overview">Was sind Plugins?</a></span></dt>
<dt><span class="section">5.1.3. <a href="plugins.html#abstractionlayer">Plugins als eine Abstraktionsschicht</a></span></dt>
<dt><span class="section">5.1.4. <a href="plugins.html#available">Welche Plugins sind verfügbar?</a></span></dt>
<dt><span class="section">5.1.5. <a href="plugins.html#obtaining">Plugins beschaffen</a></span></dt>
<dt><span class="section">5.1.6. <a href="plugins.html#hints">Zum Icinga-Benutzer wechseln</a></span></dt>
<dt><span class="section">5.1.7. <a href="plugins.html#extending">Anpassen der Umgebung</a></span></dt>
<dt><span class="section">5.1.8. <a href="plugins.html#plugins-howto">Wie benutze ich Plugin X?</a></span></dt>
<dt><span class="section">5.1.9. <a href="plugins.html#plugins-new_plugin">Integration eines neuen Plugins</a></span></dt>
<dt><span class="section">5.1.10. <a href="plugins.html#rawcommandline">Raw command line</a></span></dt>
<dt><span class="section">5.1.11. <a href="plugins.html#thresholdranges">Schwellwert und Bereiche</a></span></dt>
<dt><span class="section">5.1.12. <a href="plugins.html#errors">Aktivieren der Definition</a></span></dt>
<dt><span class="section">5.1.13. <a href="plugins.html#pluginsapi">Plugin API</a></span></dt>
</dl></div>
  

  <div class="section" title="5.1.1. Einführung">
<div class="titlepage"><div><div><h3 class="title">
<a name="introduction"></a>5.1.1. Einführung</h3></div></div></div>
    

    <p>Icinga enthält nicht, wie viele andere Überwachungs-Tools, interne Mechanismen zur Prüfung des Zustands von Hosts und
    Services in Ihrem Netzwerk. Icinga verlässt sich statt dessen auf externe Programme (Plugins genannt), die all die schmutzige
    Arbeit tun.</p>
  </div>

  <div class="section" title="5.1.2. Was sind Plugins?">
<div class="titlepage"><div><div><h3 class="title">
<a name="overview"></a>5.1.2. Was sind Plugins?</h3></div></div></div>
    

    <p>Plugins sind kompilierte Programme oder Scripts (Perl-Scripts, Shell-Scripts, usw.), die von einer Kommandozeile aus laufen
    können, um den Status eines Hosts oder Service zu prüfen. Icinga benutzt die Ergebnisse von Plugins, um den aktuellen Status von
    Hosts oder Services in Ihrem Netzwerk zu ermitteln.</p>

    <p>Icinga wird ein Plugin immer dann ausführen, wenn die Notwendigkeit besteht, den Status eines Hosts oder Service zu prüfen.
    Das Plugin tut <span class="emphasis"><em>etwas</em></span> (beachten Sie den sehr allgemeinen Ausdruck), um die Prüfung auszuführen und dann einfach die
    Ergebnisse an Icinga zurückzuliefern. Icinga wird die Ergebnisse verarbeiten, die es vom Plugin erhält, und dann
    notwendige Aktionen ausführen (starten von <a class="link" href="eventhandlers.html" title="7.3. Eventhandler">Eventhandlern</a>, senden von <a class="link" href="notifications.html" title="5.11. Benachrichtigungen">Benachrichtigungen</a>, etc).</p>
  </div>

  <div class="section" title="5.1.3. Plugins als eine Abstraktionsschicht">
<div class="titlepage"><div><div><h3 class="title">
<a name="abstractionlayer"></a>5.1.3. Plugins als eine Abstraktionsschicht</h3></div></div></div>
    

    <p><span class="inlinemediaobject"><img src="../images/plugins.png"></span></p>

    <p>Plugins arbeiten wie eine Abstraktionsschicht zwischen der Überwachungslogik im Icinga-Dämon und den eigentlichen Services
    und Hosts, die überwacht werden.</p>

    <p>Der Vorteil dieses Typs von Plugin-Architektur ist, dass Sie fast alles überwachen können, was Ihnen einfällt. Wenn Sie den
    Prozess der Überwachung automatisieren können, können Sie es mit Icinga überwachen. Es gibt bereits eine Menge von Plugins, die
    erzeugt wurden, um grundlegende Ressourcen wie z.B. Prozessorauslastung, Plattenbelegung, Ping-Raten usw. zu überwachen. Wenn Sie etwas
    anderes überwachen möchten, werfen Sie einen Blick in die Dokumentation zu <a class="link" href="pluginapi.html" title="11.1. Nagios Plugin API">Plugins schreiben</a> und
    erstellen Sie ein eigenes. Es ist einfach!</p>

    <p>Der Nachteil dieses Typs von Plugin-Architektur ist die Tatsache, dass Icinga absolut keine Ahnung davon hat, was Sie
    überwachen. Sie könnten Netzwerkverkehr-Statistiken, Datenfehler-Raten, Raumtemperatur, CPU-Spannung, Lüftergeschwindigkeit,
    Prozessorauslastung, Plattenbelegung überwachen oder die Fähigkeit Ihres superphantastischen Toasters, am Morgen Ihr Brot ordnungsgemäß
    zu bräunen... Icinga versteht nicht die Besonderheiten dessen, was überwacht wird - es verfolgt lediglich Veränderungen des
    <span class="emphasis"><em>Zustands</em></span> dieser Ressourcen. Nur die Plugins selbst wissen genau, was sie überwachen und wie die eigentlichen
    Prüfungen auszuführen sind.</p>
  </div>

  <div class="section" title="5.1.4. Welche Plugins sind verfügbar?">
<div class="titlepage"><div><div><h3 class="title">
<a name="available"></a>5.1.4. Welche Plugins sind verfügbar?</h3></div></div></div>
    

    <p>Es gibt bereits zahlreiche Plugins, um viele verschiedene Arten von Geräten und Services zu überwachen, u.a.:</p>

    <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
        <p><span class="systemitem">HTTP</span>, <span class="systemitem">POP3</span>, <span class="systemitem">IMAP</span>, <span class="systemitem">FTP</span>, <span class="systemitem">SSH</span>, <span class="systemitem">DHCP</span></p>
      </li>
<li class="listitem">
        <p>CPU-Auslastung, Plattenbelegung, Speicherauslastung, Anzahl Benutzer</p>
      </li>
<li class="listitem">
        <p>Unix/Linux, Windows- und Netware-Server</p>
      </li>
<li class="listitem">
        <p>Router und Switches</p>
      </li>
<li class="listitem">
        <p>etc.</p>
      </li>
</ul></div>
  </div>

  <div class="section" title="5.1.5. Plugins beschaffen">
<div class="titlepage"><div><div><h3 class="title">
<a name="obtaining"></a>5.1.5. Plugins beschaffen</h3></div></div></div>
    

    <p>Plugins werden nicht mit Icinga verteilt, aber Sie finden die offiziellen Nagios-Plugins zum Download und viele
    weitere Plugins, die von Nagios-Benutzern erstellt und gewartet werden, an folgenden Stellen:</p>

    <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
        <p>Monitoring Plugins Project: <a class="link" href="https://www.monitoring-plugins.org" target="_top">https://www.monitoring-plugins.org</a></p>
      </li>
<li class="listitem">
        <p>Monitoring Plugins Downloads Page: <a class="link" href="https://www.monitoring-plugins.org" target="_top">https://www.monitoring-plugins.org/download.html</a></p>
      </li>
<li class="listitem">
        <p>Icinga Exchange: <a class="link" href="https://exchange.icinga.org" target="_top">https://exchange.icinga.com</a></p>
      </li>
</ul></div>

    <p>Nach dem Herunterladen müssen Sie die Plugins installieren. Bitte lesen Sie die Dokumentation (falls vorhanden), wie das zu tun
    ist. Sie könnte wichtige Informationen über die Voraussetzungen wie z.B. zusätzliche Pakete oder (Perl-) Module enthalten, wie das
    Plugin zu installieren ist bzw. distributionsabhängige Hinweise.</p>

    <p>Manchmal müssen Sie das Plugin kompilieren, wobei Sie den Vorgang durch den Aufruf von "./configure" mit oder ohne Optionen
    vorbereiten. Bitte prüfen Sie die Datei <code class="filename">config.log</code> auf mögliche Fehler zu fehlenden (devel-)Paketen vor dem Aufuf
    des eigentlichen Compile-Vorgangs (meistens "make" oder "make all"). In den meisten Fällen wird das Plugin durch den Aufruf von "make
    install" in das Plugins-Verzeichnis (z.B. <code class="filename">/usr/local/icinga/libexec</code>) kopiert.</p>

    <p>Manchmal müssen Sie das Plugin auf Ihre Umgebung anpassen (z.B. den Pfad zu "utils.pm"). Sie können stattdessen einen logischen
    Link erzeugen, der auf das Plugin-Verzeichnis weist, so dass Sie nicht das Plugin ändern müssen, um diese Änderung zu umgehen und
    spätere Updates zu vereinfachen. Das könnte wie folgt geschehen:</p>

    <pre class="programlisting"> $&gt; mkdir /usr/local/nagios
 $&gt; ln -s /usr/local/icinga/libexec /usr/local/nagios/libexec</pre>
<div class="note" title="Anmerkung" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Anmerkung]" src="../images/note.png"></td>
<th align="left">Anmerkung</th>
</tr>
<tr><td align="left" valign="top">
        <p>Bei Verwendung von Paketen kann der Pfad zum Plugin-Verzeichnis anders lauten (z.B. <code class="filename">/usr/lib/plugins</code>), so
        dass Sie den Befehl entsprechend anpassen müssen.</p>
      </td></tr>
</table></div>
  </div>

  <div class="section" title="5.1.6. Zum Icinga-Benutzer wechseln">
<div class="titlepage"><div><div><h3 class="title">
<a name="hints"></a>5.1.6. <a name="plugins-hints"></a>Zum Icinga-Benutzer wechseln</h3></div></div></div>
    

    <div class="important" title="Wichtig" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Important">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Wichtig]" src="../images/important.png"></td>
<th align="left">Wichtig</th>
</tr>
<tr><td align="left" valign="top">
      <p>Führen Sie Plugins immer mit dem Icinga-Benutzer aus, denn einige Plugins erstellen temporäre Dateien. Wenn Sie Plugins
      mit einem anderen Benutzer ausführen, dann kann der Icinga-Benutzer diese Dateien ggf. nicht überschreiben. Wenn Sie einen
      anderen Benutzer verwenden, werden Sie nicht feststellen, ob ist der Icinga-Benutzer überhaupt berechtigt ist, auf bestimmte
      Dateien (z.B. Shared Libraries) zuzugreifen.</p>

      <p>Rufen Sie das Plugin nicht mit einem relativen Pfad auf (z.B. <code class="filename">./check_test_plugin</code>). Benutzen Sie immer
      absolute Pfade, denn so macht es auch Icinga (z.B. <code class="filename">/usr/local/icinga/libexec/check_test_plugin</code>).</p>

      <p>Bitte beachten Sie, dass der Icinga-<span class="emphasis"><em>Benutzer</em></span> eine andere Umgebung als der
      Icinga-<span class="emphasis"><em>Prozess</em></span> hat. Beim Benutzer wurden Login-Skripte durchlaufen und es ist ein Terminal mit der
      Benutzer-Sitzung verbunden, so dass die erfolgreiche Ausführung eines Plugins von der Kommandozeile aus nicht (notwendigerweise)
      bedeutet, dass es funktioniert, wenn es vom Prozess ausgeführt wird. Außerdem wird der Prozess per Default keine Shell benutzen,
      sondern Aufrufe von popen/execvp ausführen, abhängig vom Befehl (popen falls die Kommandozeile Metazeichen enthält, die Bedeutung für
      die Shell haben wie z.B. <code class="literal">!$^&amp;*()~[]\|{};&lt;&gt;?'"</code>, execvp falls keine Metazeichen vorhanden sind).</p>
    </td></tr>
</table></div>

    <p>Wechseln Sie zum Icinga-Benutzer, der in <code class="filename">icinga.cfg</code> definiert ist, falls noch nicht geschehen, und
    bereinigen Sie die Umgebung</p>

    <pre class="screen"> #&gt; su - icinga
 #&gt; env -i</pre>

    <p>Wenn Sie jetzt angemeldet sind, dann springen Sie zum Punkt "Anpassen der Umgebung".</p>

    <p>Bedingt durch das Sicherheitsbewusstsein des Packagers / Systemadministrators könnte dies fehlschlagen, weil der Account für
    Anmeldungen gesperrt ist. Bitten Sie Ihren Systemadministrator, das vorübergehend zu ändern oder führen Sie einen der folgenden Punkte
    aus</p>

    <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
        <p>ermitteln Sie die aktuelle Shell aus <code class="filename">/etc/passwd</code> und ändern Sie diese durch Ausführen von </p>
<pre class="screen"> #&gt; OLD_SHELL=`grep icinga /etc/passwd | sed 's/.*://'`
 #&gt; usermod -s /bin/sh icinga</pre>
<p>führen Sie die Befehle aus, nachdem Sie zum Icinga-Benutzer gewechselt sind und die Umgebung
        wie oben beschrieben bereinigt haben</p>

        <p>vergessen Sie nicht, die Shell-Einstellung nach dem Testen und verlassen der Sitzung wiederherzustellen</p>
<pre class="screen"> #&gt; usermod -s $OLD_SHELL icinga</pre>
      </li>
<li class="listitem">
        <p>führen Sie den Befehl über "sudo -u icinga" aus</p>

        <pre class="screen"> #&gt; sudo -u icinga /usr/local/icinga/libexec/sample-plugin.pl ...</pre>
      </li>
</ul></div>
  </div>

  <div class="section" title="5.1.7. Anpassen der Umgebung">
<div class="titlepage"><div><div><h3 class="title">
<a name="extending"></a>5.1.7. Anpassen der Umgebung</h3></div></div></div>
    

    <p>Einige Prüfungen (wie check_oracle_health) hängen davon ab, dass verschiedene Umgebungsvariablen gesetzt sind. Setzen Sie diese
    nicht in <code class="filename">.bashrc</code> oder anderen benutzerabhängigen Dateien, sondern wählen Sie dafür eine zentrale Stelle. Das
    Default-Init-Skript durchläuft die Datei <code class="filename">/etc/sysconfig/icinga</code> (wenn sie vorhanden ist), so dass es ein idealer
    Platz wäre. Benutzen Sie dafür nicht das Init-Skript selbst, weil Ihre Änderungen sonst bei Updates ggf. verloren gehen.</p>

    <p>Beispiel für <code class="filename">/etc/sysconfig/icinga</code></p>

    <pre class="programlisting"> export ORACLE_HOME=/usr/lib/oracle/11.2/client64
 export LD_LIBRARY_PATH=$ORACLE_HOME/lib
 export PATH=$PATH:$ORACLE_HOME</pre>
<p>Nachdem Sie sich angemeldet haben, sind diese Variablen noch nicht verfügbar, aber das ist
    ziemlich einfach</p>

    <pre class="screen"> $&gt; . /etc/sysconfig/icinga</pre>
<p>Bitte überprüfen Sie die Einstellungen</p>
<pre class="screen"> $&gt; echo $ORACLE_HOME
 $&gt; echo $LD_LIBRARY_PATH
 $&gt; echo $PATH</pre>
  </div>

  <div class="section" title="5.1.8. Wie benutze ich Plugin X?">
<div class="titlepage"><div><div><h3 class="title">
<a name="plugins-howto"></a>5.1.8. Wie benutze ich Plugin X?</h3></div></div></div>
    

    <p>Fast alle Plugins zeigen grundlegende Bedienungshinweise an, wenn sie von der Kommandozeile mit der Option '-h' oder '--help'
    aufgerufen werden. Wenn Sie z.B. wissen möchten, wie das Plugins check_http arbeitet bzw. welche Optionen es akzeptiert, sollten Sie
    folgenden Befehl ausprobieren:</p>

    <pre class="screen"> $&gt; ./check_http --help</pre>
  </div>

  <div class="section" title="5.1.9. Integration eines neuen Plugins">
<div class="titlepage"><div><div><h3 class="title">
<a name="plugins-new_plugin"></a>5.1.9. Integration eines neuen Plugins</h3></div></div></div>
    

    <p>Nach der Installation des Plugins rufen Sie es mit den nötigen Optionen von der Kommandozeile aus auf. Wenn dies funktioniert,
    können Sie es in Icinga integrieren.</p>

    <p>Stellen Sie sich vor, dass Sie den folgenden Aufruf benutzt haben:</p>

    <pre class="programlisting"> /usr/local/icinga/libexec/sample-plugin.pl -H 192.168.1.2 -a argument1 -p parameter -n 5</pre>

    <p>Die command-Definition enthält zwei Direktiven</p>

    <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
        <p>command_name: dies ist ein Kurzname, der den Befehl identifiziert. Lassen Sie uns <span class="emphasis"><em>check_sample</em></span>
        benutzen</p>
      </li>
<li class="listitem">
        <p>command_line: hier definieren Sie den auszuführenden Befehl. Sie könnten den Befehl angeben, den Sie auf der Kommandozeile
        benutzen, aber das wäre zu unflexibel. Normalerweise ändert sich das Plugin-Verzeichnis (/usr/local/icinga/libexec) nicht, so dass wir
        eine <a class="link" href="macrolist.html#macrolist-user">$USERn$</a>-Variable benutzen können, die in der resource.cfg definiert werden. Die
        IP-Adresse ändert sich von Host zu Host. Es gibt das Makro <a class="link" href="macrolist.html#macrolist-hostaddress">$HOSTADDRESS$</a>, das wir dafür
        nutzen können. Die Werte der Optionen können sich ändern, so dass auch sie flexibel sein sollten. Das könnte zu folgender Definition
        führen:</p>
      </li>
</ul></div>

    <pre class="programlisting"> define command{ 
    command_name check_sample
    command_line $USER1$/sample-plugin.pl -H $HOSTADDRESS$ -a $ARG1$ -p $ARG2$ -n $ARG3$
    }</pre>

    <p>Dann müssen wir die check_command-Direktive definieren, die Teil der Host-/Service-Definition ist. Es beginnt mit dem Kurznamen
    gefolgt von den Argumenten, die jeweils durch Ausrufezeichen voneinander getrennt sind:</p>

    <pre class="programlisting"> check_command check_sample!argument1!parameter!5</pre>

    <p>Wie Sie sehen, wird die IP-Adresse nicht angegeben, denn sie wird aus der Host-Definition genommen.</p>

    <p>Das zusammensetzen in umgekehrter Reihenfolge zeigt, wie Icinga die Informationen verarbeitet:</p>

    <pre class="programlisting"> check_command check_sample!argument1!parameter!5
                                |         |     +-------------------------------------+
                                |         +---------------------------------+         |
                                +---------------------------------+         |         |
                                                                  |         |         |
 Host macro ----------------------------------------+             |         |         |
                                                    |             |         |         |
 User macro --------+                               |             |         |         |
                    |                               |             |         |         |
 command_line      $USER1$/sample-plugin.pl -H $HOSTADDRESS$ -a $ARG1$ -p $ARG2$ -n $ARG3$

resultiert in:

 /usr/local/icinga/libexec/sample-plugin.pl -H 192.168.1.2 -a argument1 -p parameter -n 5</pre>

    <a name="plugins-hints2"></a>

    <p>Neben den bereits genannten gibt es eine Vielzahl von <a class="link" href="macros.html" title="5.2. Makros verstehen und wie sie arbeiten">Makros</a>, die die Arbeit erleichtern. Dabei gibt
    es einige Dinge anzumerken:</p>

    <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
        <p>Alle Icinga-Makros benutzen Großbuchstaben und werden in Dollarzeichen ($) eingeschlossen</p>
      </li>
<li class="listitem">
        <p>Die meisten Makros haben einen bestimmten Gültigkeitsbereich. Wenn Sie versuchen, ein Makro außerhalb dieses Bereichs zu
        nutzen, dann werden Sie statt des erwarteten Wertes lediglich ein Dollarzeichen ($) sehen</p>
      </li>
<li class="listitem">
        <p>Die <a class="link" href="macrolist.html#macrolist-user">$USERn$</a>-Makros können genutzt werden, um sensible Informationen wie z.B. Passwörter
        zu "verstecken", denn die Werte werden im Gegensatz zu den anderen Makros nicht im Web-Interface angezeigt. Außerdem können sie
        verwendet werden, um bestimmte Sonderzeichen nutzen zu können, die anderenfalls zu Schwierigkeiten führen. Ein Beispiel wäre
        <code class="literal">USER99=;</code>. Auf diese Weise können Sie ein Semikolon benutzen, das sonst als Start eines Kommentars in Ihrer
        Definition behandelt würde</p>
      </li>
<li class="listitem">
        <p>Nachdem es bei deutschsprachigen Personen oftmals zu Problemen kommt: <a class="link" href="macrolist.html#macrolist-hostaddress">$HOSTADDRESS$</a> wird mit zwei "D" geschrieben</p>
      </li>
</ul></div>

    <p><a name="plugins-nrpe"></a> <span class="bold"><strong>NRPE und "dont_blame_nrpe=1"</strong></span></p>

    <p>Die Benutzung von NRPE mit Argumenten erfordert etwas Aufmerksamkeit. Wenn wir annehmen, dass Sie die Argumentverarbeitung auf dem
    entfernten Rechner in der Datei <code class="filename">nrpe.cfg</code> mit Hilfe von "dont_blame_nrpe=1" (oder durch "allow_arguments=1" in
    <code class="filename">nsc.ini</code>) aktiviert haben, dann können Sie Parameter vom Icinga-Server an den entfernten Rechner übergeben.
    Lassen Sie uns folgende Definitionen annehmen.</p>

    <p>Auf dem Icinga-Server</p>
<pre class="programlisting"> define command{
    command_name check_nrpe
    command_line $USER1$/check_nrpe -H $HOSTADDRESS$ -c $ARG1$ -a $ARG2$
    }

 define service{
    ...
    check_command check_nrpe!check_process!cupsd</pre>
<p>Auf dem entfernten Rechner in der
    NRPE-Konfigurationsdatei</p>
<pre class="programlisting">...
command[check_process]=your_plugin "$ARG1$"</pre>
<p> Der Icinga-Prozess wird die Definitionen wie folgt auflösen</p>

    <pre class="programlisting"> check_command check_nrpe!check_process!cupsd
                                |         |
                                |         +---------------------------+
                                +---------------------------+         |
                                                            |         |
 Host macro ----------------------------------+             |         |
                                              |             |         |
 User macro --------+                         |             |         |
                    |                         |             |         |
 command_line      $USER1$/check_nrpe -H $HOSTADDRESS$ -c $ARG1$ -a $ARG2$

resultiert in:

 /usr/local/icinga/libexec/check_nrpe -H 192.168.1.2 -c check_process -a cupsd</pre>

    <p>Auf dem entfernten Rechner erhält der NRPE-Prozess einen Aufruf mit zwei Parametern: "check_process" und "cupsd". Der erste wird
    entfernt, um den Befehl festzulegen, der auszuführen ist, so dass nur <span class="bold"><strong>ein</strong></span> Argument an den Befehl
    übergeben wird!</p>

    <div class="note" title="Anmerkung" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Anmerkung]" src="../images/note.png"></td>
<th align="left">Anmerkung</th>
</tr>
<tr><td align="left" valign="top">
        <p>$ARG1$ auf dem entfernten Rechner ist <span class="bold"><strong>nicht</strong></span> das gleiche wie auf dem
        Icinga-Server!</p>
      </td></tr>
</table></div>
  </div>

  <div class="section" title="5.1.10. Raw command line">
<div class="titlepage"><div><div><h3 class="title">
<a name="rawcommandline"></a>5.1.10. Raw command line</h3></div></div></div>
    

    <p>Das klassische UI ermöglicht die Anzeige der Kommandozeile mit aufgelösten Variablen einschließlich der Werte aus
    <code class="filename">resource.cfg</code>. Der Klick auf "ACTIVE" neben "Check type" in den Host-/Service Check Details gibt Ihnen Zugriff auf
    diese Informationen. Wenn Sie noch keine Prüfung definiert haben, dann wählen Sie "View Config" aus den Hauptmenü auf der linken Seite
    und dann "Command expansion". Bitte beachten Sie, dass der Benutzer über die Direktive <a class="link" href="configcgi.html#configcgi-authorized_for_full_command_resolution">authorized_for_full_command_resolution</a> in <code class="filename">cgi.cfg</code>
    explizit dazu berechtigt sein muss, die Werte der Variable aus <code class="filename">resource.cfg</code> sehen zu dürfen. Außerdem muss der
    Benutzer, unter dem der Web-Server läuft, Leseberechtigung auf diese Datei besitzen.</p>

    <p>Wenn Sie die Kommandozeile protokollieren möchten, dann müssen Sie einige Direktiven in <code class="filename">icinga.cfg</code> auf die
    folgenden Werte ändern</p>

    <pre class="programlisting"> #  16 = Host/service checks
 # 256 = Commands
 debug_level=272
 debug_verbosity=2
 max_debug_file_size=1000000000</pre>
  </div>

  <div class="section" title="5.1.11. Schwellwert und Bereiche">
<div class="titlepage"><div><div><h3 class="title">
<a name="thresholdranges"></a>5.1.11. Schwellwert und Bereiche</h3></div></div></div>
    

    <p>Einige Plugins unterstützen Bereichsangaben für die Warn- und Kritisch-Werte. Bitte überprüfen Sie die Dokumentation, ob das der
    Fall für das Plugin ist, das Sie benutzen möchten. Das Folgende ist ein Auszug der (englischsprachigen) <a class="link" href="https://www.monitoring-plugins.org/doc/guidelines.html#THRESHOLDFORMAT" target="_top">Entwickler-Richtlinien</a>:</p>

    <p>Ein Bereich ist definiert als ein Start- und Endpunkt (inklusive) auf einer numerischen Skala (ggf. bis zu +/--Unendlich).</p>

    <p>Ein Schwellwert ist ein Bereich mit einem Alarmpegel (entweder Warning oder Critical).</p>

    <p>In der Theorie wird das Plugin eine Prüfung durchführen, die einen numerischen Wert oder eine Metrik zurückliefert, die dann mit
    den Warning- und Critical-Schwellwerten verglichen wird</p>

    <p>Dies ist das generelle Format für Bereiche:</p>

    <p><code class="code">[@]start:end</code></p>

    <p>Anmerkungen:</p>

    <div class="orderedlist"><ol class="orderedlist" type="1">
<li class="listitem">
        <p>start = end, falls :end nicht angegeben ist</p>
      </li>
<li class="listitem">
        <p>start und ":" ist nicht erforderlich, wenn start=0</p>
      </li>
<li class="listitem">
        <p>falls der Bereich vom Format "start:" ist und end nicht angegeben wurde, dann ist das Ende als +Unendlich anzunehmen</p>
      </li>
<li class="listitem">
        <p>um -Unendlich anzugeben, benutzen Sie "~"</p>
      </li>
<li class="listitem">
        <p>Alarm erfolgt, wenn die Metrik außerhalb des durch Start- und Ende angegebenen Bereichs liegt (Endpunkte gehören
        <span class="emphasis"><em>nicht</em></span> zum Bereich)</p>
      </li>
<li class="listitem">
        <p>wenn der Bereich mit "@" beginnt, dann ist zu alamieren, wenn die Metrik innerhalb des Bereichs liegt (einschließlich der
        Endpunkte)</p>
      </li>
</ol></div>

    <div class="note" title="Anmerkung" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Anmerkung]" src="../images/note.png"></td>
<th align="left">Anmerkung</th>
</tr>
<tr><td align="left" valign="top">
      <p>Nicht alle Plugin unterstützen (bisher) die Bereichsnotation.</p>
    </td></tr>
</table></div>

    <p>Beispiele</p>
<div class="informaltable">
        <table border="1">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td><span class="bold"><strong>Bereichsdefinition</strong></span></td>
<td><span class="bold"><strong>Alarm, wenn x...</strong></span></td>
</tr>
<tr>
<td>10</td>
<td>&lt; 0 oder &gt; 10, (außerhalb des Bereichs von {0 .. 10})</td>
</tr>
<tr>
<td>10:</td>
<td>&lt; 10, (außerhalb {10 .. Unendlich})</td>
</tr>
<tr>
<td>~:10</td>
<td>&gt; 10, (außerhalb des Bereichs von {-Unendlich .. 10})</td>
</tr>
<tr>
<td>10:20</td>
<td>&lt; 10 oder &gt; 20, (außerhalb des Bereichs von {10 .. 20})</td>
</tr>
<tr>
<td>@10:20</td>
<td>&gt;= 10 and &lt;= 20, (im Bereich von {10 .. 20})</td>
</tr>
</tbody>
</table>
      </div>

    <p>Kommandozeilenbeispiele</p>
<div class="informaltable">
        <table border="1">
<colgroup>
<col>
<col>
</colgroup>
<tbody>
<tr>
<td><span class="bold"><strong>Kommandozeile</strong></span></td>
<td><span class="bold"><strong>Erklärung</strong></span></td>
</tr>
<tr>
<td>check_stuff -w10 -c20</td>
<td>kritisch, wenn "stuff" größer als 20, andernfalls warnen, wenn größer als 10 (außerdem kritisch, wenn "stuff" kleiner
              als 0)</td>
</tr>
<tr>
<td>check_stuff -w~:10 -c~:20</td>
<td>das Gleiche wie oben, allerdings ist "stuff" kleiner als Null OK!</td>
</tr>
<tr>
<td>check_stuff -w10: -c20</td>
<td>kritisch, wenn "stuff" größer als 20, andernfalls warnen, wenn"stuff" kleiner als 10 (außerdem kritisch, wenn "stuff"
              kleiner als 0)</td>
</tr>
<tr>
<td>check_stuff -c1:</td>
<td>kritisch, wenn "stuff" kleiner als 1</td>
</tr>
<tr>
<td>check_stuff -w~:0 -c10</td>
<td>kritisch, wenn "stuff" größer als 10; warnen, wenn "stuff" größer als 0</td>
</tr>
<tr>
<td>check_stuff -c5:6</td>
<td>der einzig nicht-kritische Bereich ist 5:6</td>
</tr>
<tr>
<td>check_stuff -c@10:20</td>
<td>kritisch, wenn "stuff" zwischen 10 und 20 <span class="bold"><strong>[1]</strong></span>
</td>
</tr>
<tr>
<td>check_stuff -w20:30 -c10:40</td>
<td>warnen, wenn "stuff" kleiner als 20 oder größer als 30, kritisch, wenn "stuff" kleiner als 10 oder größer als 40
              <span class="bold"><strong>[2]</strong></span>
</td>
</tr>
</tbody>
</table>
      </div>

    <div class="note" title="Anmerkung" style="margin-left: 0.5in; margin-right: 0.5in;"><table border="0" summary="Note">
<tr>
<td rowspan="2" align="center" valign="top" width="25"><img alt="[Anmerkung]" src="../images/note.png"></td>
<th align="left">Anmerkung</th>
</tr>
<tr><td align="left" valign="top">
      <p>[1]: Bei der Kommandozeile in den Entwickler-Richtlinien fehlt "@", anderenfalls wäre die Erklärung falsch (und es gäbe kein
      Beispiel für die @-Notation)</p>

      <p>[2]: Bitte beachten Sie, dass das letzte Beispiel geschachtelte Bereiche benutzt. Das mag nicht bei allen Plugins funktionieren,
      die Bereichsangaben unterstützen. Es wurde mit check_snmp getestet</p>
    </td></tr>
</table></div>
  </div>

  <div class="section" title="5.1.12. Aktivieren der Definition">
<div class="titlepage"><div><div><h3 class="title">
<a name="errors"></a>5.1.12. Aktivieren der Definition</h3></div></div></div>
    

    <p>Prüfen Sie die Konfiguration mit "/etc/init.d/icinga show-errors" und bereinigen Sie eventuelle Fehler, bevor Sie Icinga
    mit "/etc/init.d/icinga restart" neu starten. Warten Sie, bis das Objekt geprüft wurde und betrachten Sie die Status-Details. Vielleicht
    gibt es Fehler.</p>

    <div class="itemizedlist"><ul class="itemizedlist" type="disc">
<li class="listitem">
        <p>"...resulted in a return code of 127" / "out of bounds"</p>

        <p>Das bedeutet, dass das Plugin nicht an der angegebenen Position gefunden wurde oder innerhalb des Plugins eine Datei
        aufgerufen wurde, die nicht gefunden wurde. Wenn Sie $USERn$-Makros beim Aufruf des Plugins benutzen, dann stellen Sie sicher, dass
        das Makros wirklich auf die Position verweist, wo das Plugin zu finden ist (ist das Makro in resource.cfg definiert?).
        Benachrichtigungsbefehle rufen oft ein Mail-Programm auf. Stellen Sie sicher, dass der Pfad zum Mail-Programm korrekt ist.</p>
      </li>
<li class="listitem">
        <p>"...resulted in a return code of 126"</p>

        <p>Meistens handelt es sich um ein Berechtigungsproblem. Der Benutzer kann ggf. das Plugin nicht ausführen bzw. darauf und/oder
        auf zugehörige Dateien zugreifen.</p>
      </li>
<li class="listitem">
        <p>"...resulted in a return code of 13"</p>

        <p>Meistens handelt es sich um ein Berechtigungsproblem. Der Benutzer kann ggf. das Plugin nicht ausführen bzw. darauf und/oder
        auf zugehörige Dateien zugreifen. Das kann passieren, wenn Sie als root ein Plugin ausgeführt haben, das temporäre Dateien anlegt.
        Der Icinga-Benutzer ist nicht berechtigt, diese Dateien zu überschreiben.</p>
      </li>
<li class="listitem">
        <p>(null)</p>

        <p>Der interne Aufruf von execvp lieferte nichts zurück.</p>
      </li>
</ul></div>
  </div>

  <div class="section" title="5.1.13. Plugin API">
<div class="titlepage"><div><div><h3 class="title">
<a name="pluginsapi"></a>5.1.13. Plugin API</h3></div></div></div>
    

    <p>Informationen zu technischen Aspekten von Plugins sowie zur Erstellung Ihrer eigenen Plugins finden Sie <a class="link" href="pluginapi.html" title="11.1. Nagios Plugin API">hier</a>.</p>

    <a class="indexterm" name="idm139734672816928"></a>

    <a class="indexterm" name="idm139734672815536"></a>

    <a class="indexterm" name="idm139734672814224"></a>

    <a class="indexterm" name="idm139734672812672"></a>

    <a class="indexterm" name="idm139734672810976"></a>

    <a class="indexterm" name="idm139734672809424"></a>
  </div>
</div>
<div class="navfooter">
<hr>
<table width="100%" summary="Navigation footer">
<tr>
<td width="40%" align="left">
<a accesskey="p" href="ch05.html">Zurück</a> </td>
<td width="20%" align="center"><a accesskey="u" href="ch05.html">Nach oben</a></td>
<td width="40%" align="right"> <a accesskey="n" href="macros.html">Weiter</a>
</td>
</tr>
<tr>
<td width="40%" align="left" valign="top">Kapitel 5. Die Grundlagen </td>
<td width="20%" align="center"><a accesskey="h" href="index.html">Zum Anfang</a></td>
<td width="40%" align="right" valign="top"> 5.2. Makros verstehen und wie sie arbeiten</td>
</tr>
</table>
</div>
<P class="copyright">© 1999-2009 Ethan Galstad, 2009-2017 Icinga Development Team, https://www.icinga.com</P>
</body>
</html>