Skip to content

Commit 3123361

Browse files
OwenCorrigan76see-quick
authored andcommitted
Docs integreate strimzi metrics reporter kc mm2 (strimzi#11575)
Signed-off-by: OwenCorrigan76 <owencorrigan76@gmail.com> Signed-off-by: Federico Valeri <fedevaleri@gmail.com>
1 parent 57ec674 commit 3123361

File tree

3 files changed

+33
-15
lines changed

3 files changed

+33
-15
lines changed

documentation/assemblies/metrics/assembly-metrics-config-files.adoc

Lines changed: 20 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -42,14 +42,18 @@ metrics
4242
├── strimzi-metrics-reporter
4343
| ├── grafana-dashboards <10>
4444
| | ├── strimzi-kafka.json
45+
| | ├── strimzi-kafka-connect.json
46+
| | ├── strimzi-kafka-mirror-maker-2.json
4547
| | ├── strimzi-kraft.json
46-
| └── kafka-metrics.yaml <11>
47-
├── kafka-bridge-metrics.yaml <12>
48-
├── kafka-connect-metrics.yaml <13>
49-
├── kafka-cruise-control-metrics.yaml <14>
50-
├── kafka-metrics.yaml <15>
51-
├── kafka-mirror-maker-2-metrics.yaml <16>
52-
└── oauth-metrics.yaml <17>
48+
│ ├── kafka-connect-metrics.yaml <11>
49+
│ ├── kafka-metrics.yaml <12>
50+
| └── kafka-mirror-maker-2-metrics.yaml <13>
51+
├── kafka-bridge-metrics.yaml <14>
52+
├── kafka-connect-metrics.yaml <15>
53+
├── kafka-cruise-control-metrics.yaml <16>
54+
├── kafka-metrics.yaml <17>
55+
├── kafka-mirror-maker-2-metrics.yaml <18>
56+
└── oauth-metrics.yaml <19>
5357

5458
--
5559
<1> Grafana dashboards for components using the JMX Exporter.
@@ -62,13 +66,15 @@ metrics
6266
<8> Installation resource file for the Prometheus image.
6367
<9> PodMonitor definitions translated by the Prometheus Operator into jobs for the Prometheus server to be able to scrape metrics data directly from pods.
6468
<10> Grafana dashboards for components using the Strimzi Metrics Reporter.
65-
<11> Resource for deploying and configuring Strimzi Metrics Reporter based Kafka.
66-
<12> Kafka Bridge resource with metrics enabled.
67-
<13> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Kafka Connect.
68-
<14> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Cruise Control.
69-
<15> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Kafka.
70-
<16> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for MirrorMaker 2.
71-
<17> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for OAuth 2.0.
69+
<11> `KafkaConnect` resource for deploying Kafka Connect with Strimzi Metrics Reporter.
70+
<12> `KafkaMirrorMaker2` resource for deploying MirrorMaker 2 with Strimzi Metrics Reporter.
71+
<13> `Kafka` resource for deploying Kafka with Strimzi Metrics Reporter.
72+
<14> Kafka Bridge resource with metrics enabled.
73+
<15> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Kafka Connect.
74+
<16> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Cruise Control.
75+
<17> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Kafka.
76+
<18> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for MirrorMaker 2.
77+
<19> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for OAuth 2.0.
7278

7379
NOTE: The Prometheus JMX Exporter collects Java Management Extensions (JMX) from Kafka components and converts them into Prometheus metrics.
7480
You do not require `jmxOptions` configuration in the custom resource of the component for the Prometheus JMX Exporter to function.

documentation/modules/metrics/proc-strimzi-metrics-reporter-kafka-deploy-options.adoc

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,19 @@ To enable and expose metrics in Strimzi for Prometheus, configure the appropriat
1111
Use `metricsConfig` configuration to expose metrics for these components:
1212

1313
* Kafka
14+
* Kafka Connect
15+
* Kafka MirrorMaker 2
1416

1517
This enables the {StrimziMetricsReporter}, which exposes metrics on port 9404 through an HTTP endpoint.
1618
Prometheus scrapes this endpoint to collect Kafka metrics.
1719

1820
You can create your own Prometheus configuration or use the xref:assembly-metrics-config-files-{context}[example custom resource file] provided with Strimzi:
1921

2022
* `kafka-metrics.yaml`
23+
* `kafka-connect-metrics.yaml`
24+
* `kafka-mirror-maker-2-metrics.yaml`
2125

22-
This file contains the necessary configuration, and is a good starting point for trying Prometheus with Strimzi.
26+
These files contain the necessary configuration, and are a good starting point for trying Prometheus with Strimzi.
2327

2428
This procedure shows how to deploy example Prometheus metrics configuration to the `Kafka` resource.
2529

documentation/modules/metrics/ref-strimzi-metrics-reporter-config.adoc

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,12 @@
1919
|`Kafka`
2020
|`kafka-metrics.yaml`
2121

22+
|Kafka Connect
23+
|`KafkaConnect`
24+
|`kafka-connect-metrics.yaml`
25+
26+
|Kafka MirrorMaker2
27+
|`KafkaMirrorMaker2`
28+
|`kafka-mirror-maker-2metrics.yaml`
29+
2230
|===

0 commit comments

Comments
 (0)