You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/common/en/opentelemetry.asciidoc
+34-48Lines changed: 34 additions & 48 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -42,25 +42,22 @@ ifdef::saas[]
42
42
* _Logs_ and _traces_ are currently not supported by {CE}.
43
43
endif::[]
44
44
45
-
// start translation
46
-
////
47
-
Für die Einrichtung stehen zwei Wege bereit:
45
+
There are two ways to set this up:
48
46
49
47
ifdef::onprem[]
50
-
* Seit {CMK} {v25}p9 ist ein xref:setup[Assistent] verfügbar, der Schritt für Schritt durch die Einrichtung führt und die Komponenten xref:metric_backend#[Metrik-Backend] sowie die xref:dcd[dynamische Host-Verwaltung] mit sinnvollen Standardeinstellungen versieht.
48
+
* Starting with {CMK} {v25}p9, a xref:setup[wizard] is available that guides you step by step through the setup process and configures the xref:metric_backend#[metric backend] and xref:dcd[dynamic host management] components with appropriate default settings.
51
49
endif::[]
52
50
ifdef::saas[]
53
-
* Seit Juli 2026 ist ein xref:setup[Assistent] verfügbar, der Schritt für Schritt durch die Einrichtung führt und alle Komponenten inklusive der xref:dcd[dynamischen Host-Verwaltung] mit sinnvollen Standardeinstellungen versieht.
51
+
* Since July 2026, a xref:setup[wizard] is available that guides you step by step through the setup process and configures all components—including xref:dcd[dynamic host management]—with appropriate default settings.
54
52
endif::[]
55
-
* Alternativ können Sie die beteiligten Komponenten xref:setup_manual[manuell einrichten], was natürlich Kenntnisse des Zusammenspiels erfordert.
53
+
* Alternatively, you can xref:setup_manual[manually configure] the relevant components, which of course requires knowledge of how these interact.
56
54
57
55
ifdef::onprem[]
58
-
Wenn Sie _lediglich_ Logs zur Event Console schicken wollen, benötigen Sie kein Metrik-Backend.
56
+
If you _only_ want to send logs to the Event Console, you do not need a metrics backend.
59
57
endif::[]
60
-
Falls Sie aus den OpenTelemetry-Metriken _nicht_ automatisch Hosts generieren wollen, brauchen Sie keine dynamische Host-Verwaltung.
61
-
Konfigurieren Sie in diesen beiden Fällen die benötigten Komponenten manuell.
62
-
////
63
-
// end translation
58
+
If you do _not_ want to automatically generate hosts from the OpenTelemetry metrics, you do not need dynamic host management.
59
+
In both of these cases, configure the required components manually.
60
+
64
61
65
62
[TIP]
66
63
====
@@ -71,43 +68,40 @@ ifdef::saas[]
71
68
This article describes the status of the OpenTelemetry integration as of July 2026.
72
69
endif::[]
73
70
We are continuing to work on incorporating changes made since then.
74
-
Please refer to the link:https://checkmk.com/werks?search=otel&product=cmk&cmk_version%5B%5D=2.5&level%5B%5D=1&level%5B%5D=2&level%5B%5D=3&class%5B%5D=feature&class%5B%5D=fix&class%5B%5D=security&edition=all[OpenTelemetry-related Werks^] to find out the current status of the {CMK} version you are using.
71
+
Please make use of the link:https://checkmk.com/werks?search=otel&product=cmk&cmk_version%5B%5D=2.5&level%5B%5D=1&level%5B%5D=2&level%5B%5D=3&class%5B%5D=feature&class%5B%5D=fix&class%5B%5D=security&edition=all[OpenTelemetry-related works^] to determine the current status of the {CMK} version you are using.
75
72
====
76
73
77
74
78
-
// start translation
79
-
////
80
75
[#setup]
81
-
== Geführte Einrichtung
76
+
== Guided Setup
82
77
83
78
ifdef::onprem[]
84
-
Den Assistenten für die Einrichtung finden Sie unter [.guihint]#Setup > Open Telemetry Quick Setup#, den analog zu konfigurierenden OpenTelemetry Collector als Prometheus Scraper unter [.guihint]#Setup > Prometheus Quick Setup#.
85
-
Im Assistenten geben Sie die Interfaces, Ports und Protokolle an, beziehungsweise konfigurieren Scraping-Endpunkte.
79
+
You can find the setup wizard under [.guihint]#Setup > Open Telemetry Quick Setup#, and the OpenTelemetry Collector—which is configured in the same way—as a Prometheus scraper under [.guihint]#Setup > Prometheus Quick Setup#.
80
+
In the wizard, specify the interfaces, ports, and protocols, or configure scraping endpoints.
86
81
endif::[]
87
82
ifdef::saas[]
88
-
Den Assistenten für die Einrichtung finden Sie unter [.guihint]#Setup > Open Telemetry Quick Setup#.
89
-
Im Assistenten geben Sie die Ports und Protokolle an.
83
+
You can find the setup wizard under [.guihint]#Setup > Open Telemetry Quick Setup#.
84
+
In the wizard, specify the ports and protocols.
90
85
endif::[]
91
-
Bei Einrichtung des OpenTelemetry Collectors wird Ihnen im dritten Schritt eine Musterkonfiguration für zwischengeschaltete Kollektoren angezeigt.
92
-
Sie können diese auf Filterung oder Begrenzung der Sendeintervalle erweitern.
93
-
Hierbei hilft Ihnen die Dokumentation zu link:https://opentelemetry.io/docs/collector/transforming-telemetry/[_Transforming telemetry_^] des OpenTelemetry-Projekts.
86
+
When setting up the OpenTelemetry Collector, a sample configuration for intermediate collectors is displayed in the third step.
87
+
You can extend this to include filtering or limiting the transmission intervals.
88
+
The documentation at link:https://opentelemetry.io/docs/collector/transforming-telemetry/[_Transforming telemetry_^] of the OpenTelemetry project will help you with this.
94
89
95
-
.Der Assistent fragt relevante Optionen ab und konfiguriert benötigte Komponenten automatisch mit sinnvollen Standardeinstellungen.
96
-
image::opentelemetry_quick_setup_onprem.png[alt="Der OpenTelemetry-Einrichtungsassistent mit geöffnetem Schritt zur Konfiguration des GRPC-Receivers."]
90
+
.The wizard prompts you for relevant options and automatically configures the necessary components with appropriate default settings.
91
+
image::opentelemetry_quick_setup_onprem.png[alt="The OpenTelemetry setup wizard with the step for configuring the GRPC receiver open."]
97
92
98
-
Wenn Sie nach abgeschlossener Ersteinrichtung [.guihint]#Setup > Open Telemetry Quick Setup#
93
+
// Once the initial setup is complete, i
94
+
If you select [.guihint]#Setup > Open Telemetry Quick Setup#
99
95
ifdef::onprem[]
100
-
oder [.guihint]#Setup > Prometheus Quick Setup#
96
+
or [.guihint]#Setup > Prometheus Quick Setup#
101
97
endif::[]
102
-
aufrufen, haben Sie die Möglichkeit, Ihre vorhandene Konfiguration anzupassen.
103
-
Statt erneut eine geführte Einrichtung zu durchlaufen, erlauben Ihnen die beiden Knöpfe [.guihint]#OpenTelemetry Collector# und [.guihint]#Dynamic host management#, zur Einrichtung der jeweiligen Komponente zu gelangen.
98
+
after having completed the initial setup, you will have the option to customize your existing configuration.
99
+
Instead of going through a guided setup again, the two buttons [.guihint]#OpenTelemetry Collector# and [.guihint]#Dynamic host management# allow you to proceed directly to setting up the respective component.
104
100
105
-
.Nach abgeschlossenem _Quick Setup_ können Sie in die Konfiguration der Einzelkomponenten wechseln.
106
-
image::opentelemetry_quick_setup_edit.png[alt="Quick Setup Seite, nachdem der Assistent abgeschlossen wurde: zwei Schaltflächen für 'OpenTelemetry Collector' und 'Dynamic host management'."]
101
+
.Once the _Quick Setup_ is complete, you can switch to configuring the individual components.
102
+
image::opentelemetry_quick_setup_edit.png[alt="Quick Setup page after the wizard has completed: two buttons for 'OpenTelemetry Collector' and 'Dynamic host management'."]
107
103
108
-
Den bei direkter Anpassung der Einzelkomponenten größeren Umfang an Konfigurationsmöglichkeiten zeigen wir Ihnen im folgenden Abschnitt zur xref:setup_manual[manuellen Einrichtung] und xref:dcd[Einrichtung der dynamischen Host-Verwaltung].
109
-
////
110
-
// end translation
104
+
We will show you the wider range of configuration options available when customizing individual components directly in the following sections on xref:setup_manual[manual setup] and xref:dcd[setting up dynamic host management].
111
105
112
106
113
107
ifdef::onprem[]
@@ -258,23 +252,15 @@ Each die roll you trigger in this way is transmitted to {CMK} as a data point.
258
252
259
253
There are three main ways to make use of incoming data in monitoring.
260
254
This chapter introduces these three options.
261
-
The scope of the generated services and visible metrics, as well as the flexibility and system load, differ across all of the methods.
255
+
The amount of the generated services and visible metrics, as well as the flexibility and system load, differ across all of the methods.
262
256
For this reason, it is important to choose the appropriate monitoring method for each application scenario.
263
257
264
-
* The xref:graphing#custom_graphs[custom graphs] visualize data directly from the metrics backend in dashboards — without going through services and without even involving the monitoring core.
258
+
* The xref:graphing#custom_graphs[custom graphs] visualize data directly from the metrics backend in dashboards—without going through services and without even involving the monitoring core.
265
259
You can create rules for the special agent described in the following list item directly from custom graphs.
266
260
267
-
// delete from here
268
-
* Using xref:special_agent_option[special agent for selected metrics] is useful when you want to assign some data points received via OpenTelemetry to existing or newly created hosts, and are looking for a way to map data from different sources to the hosts to which they belong organizationally or technically.
269
-
The overhead of this method is slightly higher, which is usually offset by the fact that a smaller volume of data is queried.
270
-
// delete to here
271
-
// start translation
272
-
////
273
-
* Die Verwendung von xref:special_agent_option[Custom Metrics] (über die Erstellung von _custom queries_) ist dann sinnvoll, wenn Sie einige per OpenTelemetry empfangene Datenpunkte vorhandenen oder extra angelegten Hosts zuordnen wollen.
274
-
Dies schafft die Möglichkeit, Daten aus unterschiedlichen Quellen den Hosts zuzuordnen, zu denen sie organisatorisch oder technisch gehören.
275
-
Der Overhead dieser Methode ist etwas höher, was meist dadurch wett gemacht wird, dass ein geringerer Umfang an Daten abgefragt wird.
276
-
////
277
-
// end translation
261
+
* Using xref:special_agent_option[Custom Metrics] (by creating _custom queries_) is useful when you want to map certain data points received via OpenTelemetry to existing or newly created hosts.
262
+
This makes it possible to map data from different sources to the hosts to which they belong, either organizationally or technically.
263
+
The overhead of this method is slightly higher, but this is usually offset by the fact that a smaller volume of data is queried.
278
264
279
265
* Using xref:dcd[dynamic host management] is ideal when it is possible to precisely map OpenTelemetry services to {CMK} hosts and OpenTelemetry metrics to {CMK} services.
280
266
Since a dedicated fetcher is used and data therefore takes a very direct path, this approach is highly efficient.
@@ -326,7 +312,7 @@ If you create multiple rules for special agents from custom graphs, only the fir
326
312
====
327
313
328
314
.In the rules for special agents you can edit or create new custom metrics
329
-
image::opentelemetry_special_agent_rule.png[alt="In the rules for special agents, you can edit or create new custom metrics."]
315
+
image::opentelemetry_special_agent_rule.png[alt="In the rules for special agents you can edit or create new custom metrics."]
330
316
331
317
ifdef::onprem[]
332
318
Since the metrics generated by the special agent follow the 'classic' path through the monitoring core and RRDs, they are not affected by the xref:metric_backend#distributed[restrictions in distributed monitoring].
@@ -425,4 +411,4 @@ The thresholds for transitioning to {WARN} and {CRIT} are the memory usage thres
425
411
426
412
In addition to memory usage, the service displays graphs for incoming OpenTelemetry metrics, those forwarded to the metrics backend, and those rejected.
427
413
This can help with debugging ("Is any data even reaching the collector?") or be useful for identifying bottlenecks ("Whoa, there's always a lot of activity here at 2 a.m.!").
0 commit comments