Skip to content

Commit 6a79a63

Browse files
sebkirMattias Schlenker
authored andcommitted
added anchors and cleaned up a few dashes
(cherry picked from commit 45b3ca5)
1 parent 1fbd89b commit 6a79a63

2 files changed

Lines changed: 19 additions & 14 deletions

File tree

src/common/de/monitoring_docker.asciidoc

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ Eine Vorlage mit ausführlichen Erläuterungen hierzu finden Sie im {CMK} Verzei
106106
In den kommerziellen Editionen können Sie alle Parameter bequem mit der xref:wato_monitoringagents#bakery[Agentenbäckerei] einstellen.
107107

108108

109+
[#monitoring_containers]
109110
=== Container überwachen
110111

111112
==== Container-Hosts anlegen
@@ -194,6 +195,7 @@ endif::[]
194195
[#diagnose]
195196
== Diagnosemöglichkeiten
196197

198+
[#diagnosis_docker_host]
197199
=== Diagnose für einen Docker-Node
198200

199201
Sollte die Einrichtung nicht klappen, gibt es verschiedene Möglichkeiten der Analyse des Problems.
@@ -231,6 +233,7 @@ Prüfen Sie dann gegebenenfalls Ihre Docker-Installation:
231233
----
232234

233235

236+
[#diagnosis_container_host]
234237
=== Diagnose für einen Container-Host
235238

236239
Falls der Container-Host keine Daten erhält bzw. keine Services erkannt werden, prüfen Sie zuerst, ob die Piggyback-Daten zu diesem Host vorhanden sind.

src/common/en/monitoring_docker.asciidoc

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ As necessary as end-to-end and transparent monitoring of containers is, it is al
2626
But {CMK} monitors not only the general status of the daemon or the container, but also the container itself.
2727
A full list of the elements that can currently be monitored can be found in the link:https://checkmk.com/integrations[Catalog of check plug-ins^].
2828

29-
Alongside the status and inventory information which {CMK} can determine over the node (docker-jargon for the host on which the containers are running), {CMK} can also determine detailed status information for the containers.
29+
Alongside the status and inventory information which {CMK} can determine over the node (docker-jargon for 'the host on which the containers are running'), {CMK} can also determine detailed status information for the containers.
3030
For this every container has to be added as a separate host in {CMK} if the container is to be monitored.
3131
Its data will be xref:glossar#piggyback[piggybacked] from the node to this host.
3232

@@ -105,6 +105,7 @@ A template with detailed explanations can be found in the {CMK} directory `~/sha
105105
In the commercial editions you can easily configure all parameters with the xref:wato_monitoringagents#bakery[Agent Bakery].
106106

107107

108+
[#monitoring_containers]
108109
=== Monitoring the containers
109110

110111
==== Creating the container hosts
@@ -113,7 +114,7 @@ Of course the interesting aspect is the monitoring of the Docker containers.
113114
This will be implemented automatically by installing the plug-ins, however the services will not be assigned to the docker node, rather {CMK} assumes a single host per docker container.
114115

115116
The mechanism used here is called xref:glossar#piggyback[piggyback]:
116-
The plug-in or special agent transports data of other hosts -- ‘piggybacked so to speak -- alongside its own data.
117+
The plug-in or special agent transports data of other hosts—​'piggybacked' so to speak--alongside its own data.
117118
{CMK} places this data in the `~/tmp/check_mk/piggyback` directory.
118119
All you have to do in the Setup is to create hosts with the correct names, and the services will then be automatically assigned to them.
119120

@@ -135,7 +136,7 @@ However since many services monitored by the agent within the containers actuall
135136

136137
==== Alternative names for container hosts
137138

138-
By default -- as mentioned above -- the 12-character short ID for the container is used as the name for the container host.
139+
By default--as mentioned above--the 12-character short ID for the container is used as the name for the container host.
139140
This can optionally be configured differently.
140141
To do this, in the configuration file `docker.cfg` (see xref:finetuning[Fine tuning the plug-in]) set the `container_id` option to `long` in order to use the complete container ID as the name, or to `name` in order to use the container name.
141142

@@ -154,14 +155,14 @@ See the xref:piggyback#renamehosts[The piggyback mechanism] article for more opt
154155
==== Monitoring the host state
155156

156157
ifdef::onprem[]
157-
Since a containers xref:monitoring_basics#hosts[host state] cannot really be verified using xref:cmc_differences#smartping[TCP packets or ICMP], this must be determined in another way.
158-
The [.guihint]#Docker container status# service facilitates this -- in any case it checks whether the container is running, and can thus be used as a secure tool for detecting the host state.
158+
Since a container's xref:monitoring_basics#hosts[host state] cannot really be verified using xref:cmc_differences#smartping[TCP packets or ICMP], this must be determined in another way.
159+
The [.guihint]#Docker container status# service facilitates this--in any case it checks whether the container is running, and can thus be used as a secure tool for detecting the host state.
159160
endif::[]
160161
ifdef::saas[]
161-
For monitoring the containers xref:monitoring_basics#hosts[host state], using the [.guihint]#Docker container status# service seems obvious -- in any case it checks whether the container is running, and can thus be used as a secure tool for detecting the host state.
162+
For monitoring the container's xref:monitoring_basics#hosts[host state], using the [.guihint]#Docker container status# service seems obvious--in any case it checks whether the container is running, and can thus be used as a secure tool for detecting the host state.
162163
endif::[]
163164
Define a rule in the [.guihint]#Host check command# rule set for this purpose, and set the [.guihint]#Use the status of the service...# option to the mentioned service.
164-
Dont forget to set the conditions so that only containers are affected.
165+
Don't forget to set the conditions so that only containers are affected.
165166
In our example all containers are located in a folder with the same name:
166167

167168
image::docker_container_hoststatus.png[alt="Rule for the command to check the host state of the containers."]
@@ -174,7 +175,7 @@ This is especially true for the roll out of agent plug-ins.
174175
The three plug-ins `mem`, `cpu` and `diskstat` (Disk I/O) work without an agent in the container though, and are analyzed by the {CMK} agent on the node itself.
175176

176177
Especially for self-created Docker images you might want to roll out the agent itself into the container.
177-
In this case the data is no longer analyzed -- as described above -- by the Docker nodes agent.
178+
In this case the data is no longer analyzed--as described above--by the Docker node's agent.
178179
Instead of this a separate agent runs in each container.
179180
Calling this agent will still be bundled in a piggyback procedure via the Docker node however.
180181

@@ -183,21 +184,22 @@ Especially with minimally-built containers based on Alpine Linux it could very w
183184
In such a situation you should monitor the container from the Docker node.
184185

185186
ifdef::onprem[]
186-
The use of the [.guihint]#Host check command# rule set will in this case only be required if the container is not pingable -- but it will otherwise function exactly as described above.
187+
The use of the [.guihint]#Host check command# rule set will in this case only be required if the container is not pingable--but it will otherwise function exactly as described above.
187188
endif::[]
188189

189190

190191
[#diagnose]
191192
== Diagnostic options
192193

194+
[#diagnosis_docker_host]
193195
=== Diagnosis of a Docker node
194196

195197
Should the setup not be successful, there are a number of options for analyzing the problem.
196198
ifdef::onprem[]
197199
If applicable, verify that a {CMK} agent with at least version {v15} or a later version is installed on the host.
198200
endif::[]
199201

200-
If the version of the agent on the host is suitable, next check if the data is present in the agents output.
202+
If the version of the agent on the host is suitable, next check if the data is present in the agent's output.
201203
You can download the output as a text file: in a host view in monitoring via the [.guihint]#Download agent output# action menu entry:
202204

203205
image::docker_node_dropdown.png[alt="Action menu of the host in monitoring with the entry for downloading the agent output.", width=65%]
@@ -226,11 +228,11 @@ If necessary, check your Docker installation:
226228
{c-root} docker info 2>&1
227229
----
228230

229-
231+
[#diagnosis_container_host]
230232
=== Diagnosis for a container host
231233

232234
If the container host receives no data, or respectively, no services are detected, first check if piggyback data is available for this host.
233-
The hosts name must be identical to the ID of the container.
235+
The host's name must be identical to the ID of the container.
234236
Alternatively, you can also make a manual assignment using the [.guihint]#Host name translation for piggybacked hosts# rule set.
235237
Here, however, only the [.guihint]#Explicit hostname mapping# option is suitable:
236238

@@ -267,7 +269,7 @@ ifdef::onprem[]
267269
|===
268270
|File path |Function
269271

270-
|`~/tmp/check_mk/piggyback/` |{CMK} saves the piggyback data here. For each piggybacked host a subfolder is created with the hosts name -- this subfolder contains a text file with the hosts data. The filename is the name of the piggyback host providing the data.
271-
|`~/tmp/check_mk/cache/` |Here the most recent agent output from all hosts is saved temporarily. The contents of a hosts file is identical to that from the `cmk -d myserver123` command.
272+
|`~/tmp/check_mk/piggyback/` |{CMK} saves the piggyback data here. For each piggybacked host a subfolder is created with the host's name--this subfolder contains a text file with the host's data. The filename is the name of the piggyback host providing the data.
273+
|`~/tmp/check_mk/cache/` |Here the most recent agent output from all hosts is saved temporarily. The contents of a host's file is identical to that from the `cmk -d myserver123` command.
272274
|===
273275
endif::[]

0 commit comments

Comments
 (0)