Skip to content

Commit 4d75643

Browse files
thomaskoslowskiMattias Schlenker
authored andcommitted
content-sync - KNW-1944 translation finished, pick-24
1 parent 41abba8 commit 4d75643

File tree

2 files changed

+29
-32
lines changed

2 files changed

+29
-32
lines changed

src/onprem/de/devel_check_plugins.asciidoc

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
// -*- coding: utf-8 -*-
22
// IGNORE % 1000er 1024er check_mk →
3+
// NONASCII
34
include::global_attr.adoc[]
45
= Agentenbasierte Check-Plugins entwickeln
56
:title: Agentenbasierte Check-Plugins entwickeln
67
:description: Bei Bedarf können Sie Ihre eigenen agentenbasierten {CMK}-Plugins mit Python entwickeln. Lesen Sie hier, wie Sie ein Plugin selbst erstellen und nutzen.
8+
:experimental:
79

810
{related-start}
911
xref:devel_intro#[Erweiterungen für {CMK} entwickeln]
@@ -50,7 +52,7 @@ In der {CMK}-Version {current-major} ist die Check-API V2 die aktuelle Version.
5052
Wir zeigen Ihnen in diesem Artikel, wie Sie die Check-API Version 2 für die Plugin-Programmierung nutzen können.
5153
Hinweise zum Umstieg auf die Check-API Version 2 finden Sie am Ende dieses Artikels im Kapitel xref:migration[Migration.]
5254

53-
Über die {CMK}-Benutzeroberfläche haben Sie jederzeit Zugriff auf die Dokumentation der Check-API: [.guihint]#Help > Developer resources > Plugin API references.#
55+
Über die {CMK}-Benutzeroberfläche haben Sie jederzeit Zugriff auf die Dokumentation der Check-API: [.guihint]#Help > Developer resources > Plugin API references#.
5456
Wählen Sie im neuen Browserfenster in der linken Navigationsleiste [.guihint]#Agent based ("Check API") > Version 2# aus:
5557

5658
[{image-border}]
@@ -302,7 +304,7 @@ Rufen Sie als `root` den Befehl `check_mk_agent` auf:
302304
Irgendwo in der sehr langen Ausgabe muss die neue Sektion erscheinen.
303305
Agentenplugins werden vom Agenten zum Schluss ausgegeben.
304306

305-
Durch Anhängen von `less` können Sie in der Ausgabe blättern (drücken Sie die Leertaste zum Blättern, `/` zum Suchen und `q` zum Beenden):
307+
Durch Anhängen von `less` können Sie in der Ausgabe blättern (drücken Sie die kbd:[Leertaste] zum Blättern, kbd:[/] zum Suchen und kbd:[Q] zum Beenden):
306308

307309
[{shell}]
308310
----
@@ -699,7 +701,7 @@ Validating Nagios configuration...OK
699701
Restarting monitoring core...OK
700702
----
701703

702-
Im Monitoring von {CMK} finden Sie nun beim Host `localhost` den neuen Service [.guihint]#Host group check_mk:#
704+
Im Monitoring von {CMK} finden Sie nun beim Host `localhost` den neuen Service [.guihint]#Host group check_mk#.
703705

704706
.Da die Host-Gruppe `check_mk` nicht leer ist, ist der Service {CRIT}
705707
image::devel_cpi_service_simple.png[alt="Der vom Check-Plugin erzeugte neue Service im Monitoring."]
@@ -980,7 +982,7 @@ Diese steht in der Spalte [.guihint]#Summary# -- wie im vorherigen Screenshot zu
980982
Die Idee ist, dass dieser Text eine Länge von 60 Zeichen nicht überschreitet.
981983
Das sorgt dann immer für eine übersichtliche Tabellendarstellung ohne störende Zeilenumbrüche.
982984

983-
Daneben gibt es noch das Feld [.guihint]#Details,# in dem alle Details zum Zustand des Services angezeigt werden, wobei alle Informationen des Summary auch in den Details enthalten sind.
985+
Daneben gibt es noch das Feld [.guihint]#Details#, in dem alle Details zum Zustand des Services angezeigt werden, wobei alle Informationen des Summary auch in den Details enthalten sind.
984986
Nach Anklicken des Services wird die Service-Seite geöffnet, in der neben vielen anderen auch die beiden Felder [.guihint]#Summary# und [.guihint]#Details# zu sehen sind.
985987

986988
Beim Aufruf von `yield Result(pass:[...])` können Sie bestimmen, welche Informationen so wichtig sind, dass sie im Summary angezeigt werden sollen, und bei welchen es genügt, dass diese in den Details erscheinen.
@@ -1076,7 +1078,7 @@ Auch das bisher einzig existierende Resultat bleibt (fast) unverändert:
10761078
)
10771079
----
10781080

1079-
Nur der Zugriff im Python-„F-String“ auf den Ausdruck, der den Wert liefert, ist nun einfacher als xref:#summary_details_yield[zuvor], da das `attr` bereits in den Variablendefinitionen steckt.
1081+
Nur der Zugriff im Python-„F-String“ auf den Ausdruck, der den Wert liefert, ist nun einfacher als xref:summary_details_yield[zuvor], da das `attr` bereits in den Variablendefinitionen steckt.
10801082

10811083
Nun zum eigentlichen Kern der Erweiterung, der Definition eines Resultats, das die folgende Aussage umsetzt:
10821084
„Der Service der Host-Gruppe ist {WARN}, wenn 90{nbsp}% der Hosts {UP} sind, und {CRIT} bei 80{nbsp}% der Hosts.“
@@ -1302,7 +1304,7 @@ Dazu benötigen Sie einen xref:glossar#rule_set[Regelsatz.]
13021304

13031305
Mit der Erstellung eines Regelsatzes _für_ ein Check-Plugin verlassen Sie die Check-Plugin-Entwicklung und wechseln Dateiverzeichnis, Datei und API.
13041306
Seit {CMK} {v23} unterstützt Sie die *Rulesets-API* bei der Erstellung solcher Regelsätze für Check-Plugins.
1305-
Die API-Dokumentation für Regelsätze finden Sie in Ihrer {CMK}-Instanz auf der gleichen Seite wie die der xref:check_api_doc[Check-API] unter [.guihint]#Rulesets > Version 1.#
1307+
Die API-Dokumentation für Regelsätze finden Sie in Ihrer {CMK}-Instanz auf der gleichen Seite wie die der xref:check_api_doc[Check-API] unter [.guihint]#Rulesets > Version 1#.
13061308

13071309

13081310
[#new_ruleset]
@@ -1415,7 +1417,7 @@ Um bei mehreren neuen Regelsätzen den Überblick zu behalten, empfiehlt es sich
14151417
* `title` legt den Titel des Regelsatzes fest, so wie er auch in der {CMK}-GUI erscheint.
14161418

14171419
* Das `topic` legt fest, wo im [.guihint]#Setup# der Regelsatz auftauchen soll.
1418-
Mit dem im Beispiel gewählten Wert finden Sie den Regelsatz unter [.guihint]#Setup > Services > Service monitoring rules# im Kasten [.guihint]#Various,# wo er in aller Regel gut aufgehoben ist.
1420+
Mit dem im Beispiel gewählten Wert finden Sie den Regelsatz unter [.guihint]#Setup > Services > Service monitoring rules# im Kasten [.guihint]#Various#, wo er in aller Regel gut aufgehoben ist.
14191421

14201422
* Als `parameter_form` geben Sie den Namen der zuvor erstellten Funktion ein.
14211423

@@ -1576,14 +1578,14 @@ check_plugin_myhostgroups_advanced = CheckPlugin(
15761578
----
15771579

15781580
Sie sollten Standardwerte immer auf diese Weise übergeben (und den Fall fehlender Parameter nicht im Check-Plugin abfangen), da diese Standardwerte auch in der [.guihint]#Setup#-Oberfläche angezeigt werden können.
1579-
Dazu gibt es zum Beispiel bei der Service-Erkennung eines Hosts, auf der Seite [.guihint]#Services of host#, im Menü [.guihint]#Display# den Schalter [.guihint]#Show check parameters.#
1581+
Dazu gibt es zum Beispiel bei der Service-Erkennung eines Hosts, auf der Seite [.guihint]#Services of host#, im Menü [.guihint]#Display# den Schalter [.guihint]#Show check parameters#.
15801582

15811583
[TIP]
15821584
====
15831585
Auf GitHub finden Sie sowohl die Datei mit dem
15841586
link:https://github.com/Checkmk/checkmk-docs/blob/master/examples/devel_check_plugins/ruleset_myhostgroups.py[Regelsatz^]
15851587
als auch das um den Regelsatz erweiterte
1586-
link:https://github.com/Checkmk/checkmk-docs/blob/master/examples/devel_check_plugins/check_plugin_advanced_myhostgroups.py[Check-Plugin.^]
1588+
link:https://github.com/Checkmk/checkmk-docs/blob/master/examples/devel_check_plugins/check_plugin_advanced_myhostgroups.py[Check-Plugin^].
15871589
====
15881590

15891591

@@ -1631,7 +1633,7 @@ Allerdings gibt es dabei ein paar Einschränkungen:
16311633
Um die Darstellung Ihrer Metriken in diesen Belangen zu vervollständigen, benötigen Sie _Metrikdefinitionen._
16321634

16331635
So wie für xref:rule_set[Regelsätze] gibt es seit {CMK} {v23} mit der *Graphing-API* auch eine eigene API für Metriken, Graphen und Perf-O-Meter.
1634-
Die Dokumentation der Graphing-API finden Sie in Ihrer {CMK}-Instanz auf der gleichen Seite wie die der xref:check_api_doc[Check-API] unter [.guihint]#Graphing > Version 1.#
1636+
Die Dokumentation der Graphing-API finden Sie in Ihrer {CMK}-Instanz auf der gleichen Seite wie die der xref:check_api_doc[Check-API] unter [.guihint]#Graphing > Version 1#.
16351637

16361638

16371639
[#new_metricdefinition]
@@ -1684,7 +1686,7 @@ Hier die Erklärung dazu:
16841686

16851687
* Die verfügbaren Einheiten (`unit`) können Sie in der API-Dokumentation nachlesen, sie enden alle auf `Notation`, z. B. `DecimalNotation`, `EngineeringScientificNotation` oder `TimeNotation`.
16861688

1687-
* Die in {CMK} verwendeten Farbnamen für die Farbdefinition `color` finden Sie auf link:https://github.com/Checkmk/checkmk/blob/master/packages/cmk-plugin-apis/cmk/graphing/v1/metrics.py[GitHub.^]
1689+
* Die in {CMK} verwendeten Farbnamen für die Farbdefinition `color` finden Sie auf link:https://github.com/Checkmk/checkmk/blob/master/packages/cmk-plugin-apis/cmk/graphing/v1/metrics.py[GitHub^].
16881690

16891691
Diese Definition in der Graphing-Datei sorgt jetzt dafür, dass Titel, Einheit und Farbe der Metrik angepasst dargestellt werden.
16901692

@@ -2229,9 +2231,9 @@ Um Ihre Check-Plugins weiter nutzen zu können müssen Sie diese noch unter {v23
22292231

22302232
Die folgenden Informationen helfen Ihnen bei der Migration von Check-Plugins der Check-API V1 auf die V2:
22312233

2232-
* Die neue Verzeichnisstruktur und Namenskonvention zur Ablage der Dateien für alle Plugin-APIs finden Sie in der xref:check_api_doc[API-Dokumentation] auf der Hauptseite [.guihint]#Checkmk's Plug-in APIs.#
2234+
* Die neue Verzeichnisstruktur und Namenskonvention zur Ablage der Dateien für alle Plugin-APIs finden Sie in der xref:check_api_doc[API-Dokumentation] auf der Hauptseite [.guihint]#Checkmk's Plug-in APIs#.
22332235

2234-
* Die Zusammenfassung der Änderungen in der Check-API V2 steht ebenfalls in der API-Dokumentation in [.guihint]#Checkmk's Plug-in APIs > Agent based ("Check API") > Version 2 > New in this version.#
2236+
* Die Zusammenfassung der Änderungen in der Check-API V2 steht ebenfalls in der API-Dokumentation in [.guihint]#Checkmk's Plug-in APIs > Agent based ("Check API") > Version 2 > New in this version#.
22352237
Dort finden Sie auch den Link zu einem GitHub-Commit, der das bestehende Check-Plugin `apt` zur Check-API V2 migriert.
22362238

22372239
* Auf link:https://github.com/Checkmk/checkmk/tree/master/doc/treasures/migration_helpers/[GitHub^] finden Sie im `treasures`-Verzeichnis von {CMK} Skripte, die Ihnen bei der Migration auf die neuen APIs helfen.

src/onprem/en/devel_check_plugins.asciidoc

Lines changed: 14 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
// -*- coding: utf-8 -*-
22
// IGNORE % check_mk lt pre →
3+
// NONASCII
34
include::global_attr.adoc[]
45
= Developing agent-based check plug-ins
56
:title: Developing agent-based check plug-ins
67
:description: If desired, you can create your own agent-based {CMK} plug-ins with Python. Read here how to create and use such a plug-in.
8+
:experimental:
79

810
{related-start}
911
xref:devel_intro#[Developing extensions for {CMK}]
@@ -264,23 +266,17 @@ check_mk;localhost
264266

265267
Host groups that do not contain any hosts are not listed here.
266268

267-
// This block is new
268-
// start translation
269-
////
270269
[TIP]
271270
====
272-
Unser Beispiel verwendet ein sehr einfaches Shellskript als Agentenplugin.
273-
In vielen Fällen werden Sie eine leichter zu wartende Skriptsprache oder Binärdateien verwenden wollen.
274-
Alles, was auf dem Zielsystem ausführbar ist, ist zugelassen.
275-
Bei Verwendung von Python ist ein kleines Detail zu beachten:
276-
Falls kein Suffix `.py` im Dateinamen vorhanden ist, wird wie bei allen anderen Skriptsprachen der „Shebang“ ausgewertet.
277-
Ist das Suffix `.py` vorhanden, wird der Shebang ignoriert, stattdessen sucht der {CMK}-Agent nach dem Python-Interpreter.
278-
Dessen absoluten Pfad können Sie auch in der Konfigurationsdatei `$MK_CONFDIR/python_path.cfg` abweichend vom System-Python als Variable `PYTHON3` übergeben.
279-
Das ist praktisch, wenn ein Plugin auf spezielle Python-Module und als Folge auf ein link:https://docs.python.org/3/library/venv.html[Python Virtual Environment (`venv`)^] angewiesen ist.
271+
Our example uses a very simple shell script as an agent plug-in.
272+
In many cases, you will want to use a scripting language or binary files that are easier to maintain.
273+
Anything that is executable on the target system is permitted.
274+
When using Python, there is one small detail to note:
275+
If there is no `.py` suffix in the file name, the 'shebang' is evaluated as with all other scripting languages.
276+
If the `.py` suffix is present, the shebang is ignored and the {CMK} agent will instead search for the Python interpreter.
277+
You can also specify its absolute file path in the configuration file `$MK_CONFDIR/python_path.cfg` as the variable `PYTHON3`, which differs from the system Python.
278+
This is useful if a plug-in requires specific Python modules and, as a result, is dependent on a link:https://docs.python.org/3/library/venv.html[Python Virtual Environment (`venv`)^].
280279
====
281-
////
282-
// end translation
283-
284280

285281
[#test_agent]
286282
=== Testing the agent
@@ -306,7 +302,7 @@ As `root`, call the `check_mk_agent` command:
306302
The new section must appear somewhere in the very long output.
307303
Agent plug-ins are output by the agent at the end of processing.
308304

309-
You can scroll through the output by appending `less` (press the space bar to scroll, `/` to search and `q` to exit):
305+
You can scroll through the output by appending `less` (press the kbd:[Spacebar] to scroll, kbd:[/] to search and kbd:[Q] to exit):
310306

311307
[{shell}]
312308
----
@@ -1081,7 +1077,7 @@ The only existing result remains (almost) unchanged:
10811077
)
10821078
----
10831079

1084-
Only the access in the Python 'F-String' to the expression that returns the value is now easier than xref:#summary_details_yield[previously], since the `attr` is already in the variable definitions.
1080+
Only the access in the Python 'F-String' to the expression that returns the value is now easier than xref:summary_details_yield[previously], since the `attr` is already in the variable definitions.
10851081

10861082
Now to the actual core of the extension, the definition of a result that implements the following statement:
10871083
"The service of the host group is {WARN} when 90{nbsp}% of the hosts are {UP}, and {CRIT} when 80{nbsp}% of the hosts are {UP}."
@@ -1684,7 +1680,7 @@ Here is the explanation:
16841680

16851681
* The available units (`unit`) can be found in the API documentation, these all end in `Notation`, e.g. `DecimalNotation`, `EngineeringScientificNotation` or `TimeNotation`.
16861682

1687-
* The color names used in {CMK} for the `color` definition can be found at link:https://github.com/Checkmk/checkmk/blob/master/packages/cmk-plugin-apis/cmk/graphing/v1/metrics.py[GitHub.^]
1683+
* The color names used in {CMK} for the `color` definition can be found at link:https://github.com/Checkmk/checkmk/blob/master/packages/cmk-plugin-apis/cmk/graphing/v1/metrics.py[GitHub^].
16881684

16891685
This definition in the graphing file now ensures that the metric's title, unit and color are displayed appropriately.
16901686

@@ -2249,5 +2245,4 @@ include::include_treasures_admonition.asciidoc[]
22492245
|`~/local/lib/python3/cmk_addons/plugins/<plug-in_family>/rulesets/` |Storage location for rule set files created according to the Rulesets API.
22502246
|`~/local/lib/python3/cmk_addons/plugins/<plug-in_family>/graphing/` |Storage location for graphing files created according to the Graphing API.
22512247
|`/usr/lib/check_mk_agent/plugins/` |This directory is located on a monitored Linux host. The {CMK} agent for Linux expects extensions of the agent (agent plug-ins) here.
2252-
|===
2253-
2248+
|===

0 commit comments

Comments
 (0)