Update assemblies and modules Docs for Metrics Reporter integration (strimzi#11329)

Signed-off-by: OwenCorrigan76 <owencorrigan76@gmail.com>

Author: OwenCorrigan76

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

@@ -39,15 +39,20 @@ metrics
 │    ├── prometheus-rules.yaml <7>
 │    ├── prometheus.yaml <8>
 │    └── strimzi-pod-monitor.yaml <9>
-├── kafka-bridge-metrics.yaml <10>
-├── kafka-connect-metrics.yaml <11>
-├── kafka-cruise-control-metrics.yaml <12>
-├── kafka-metrics.yaml <13>
-├── kafka-mirror-maker-2-metrics.yaml <14>
-└── oauth-metrics.yaml <15>
+├── strimzi-metrics-reporter
+|    ├── grafana-dashboards <10>
+|    |  ├── strimzi-kafka.json
+|    |  ├── strimzi-kraft.json
+|    └── kafka-metrics.yaml <11>
+├── kafka-bridge-metrics.yaml <12>
+├── kafka-connect-metrics.yaml <13>
+├── kafka-cruise-control-metrics.yaml <14>
+├── kafka-metrics.yaml <15>
+├── kafka-mirror-maker-2-metrics.yaml <16>
+└── oauth-metrics.yaml <17>
 
 --
-<1> Example Grafana dashboards for the different Strimzi components.
+<1> Grafana dashboards for components using the JMX Exporter.
 <2> Installation file for the Grafana image.
 <3> Kube-state-metrics deployment and configuration files for custom resource monitoring.
 <4> Additional configuration to scrape metrics for CPU, memory and disk volume usage, which comes directly from the Kubernetes cAdvisor agent and kubelet on the nodes.
@@ -56,19 +61,28 @@ metrics
 <7> Alerting rules examples for use with Prometheus Alertmanager (deployed with Prometheus).
 <8> Installation resource file for the Prometheus image.
 <9> PodMonitor definitions translated by the Prometheus Operator into jobs for the Prometheus server to be able to scrape metrics data directly from pods.
-<10> Kafka Bridge resource with metrics enabled.
-<11> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Kafka Connect.
-<12> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Cruise Control.
-<13> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Kafka.
-<14> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for MirrorMaker 2.
-<15> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for OAuth 2.0.
+<10> Grafana dashboards for components using the Strimzi Metrics Reporter.
+<11> Resource for deploying and configuring Strimzi Metrics Reporter based Kafka.
+<12> Kafka Bridge resource with metrics enabled.
+<13> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Kafka Connect.
+<14> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Cruise Control.
+<15> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for Kafka.
+<16> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for MirrorMaker 2.
+<17> Metrics configuration that defines Prometheus JMX Exporter relabeling rules for OAuth 2.0.
 
 NOTE: The Prometheus JMX Exporter collects Java Management Extensions (JMX) from Kafka components and converts them into Prometheus metrics.
 You do not require `jmxOptions` configuration in the custom resource of the component for the Prometheus JMX Exporter to function.
 `jmxOptions` is only required if you need direct access to JMX from Kafka components.
 
-//Example Prometheus metrics files
-include::../../modules/metrics/ref-prometheus-metrics-config.adoc[leveloffset=+1]
+Strimzi uses the {StrimziMetricsReporter} or the {JMXExporter} to expose metrics through an HTTP endpoint, which can be scraped by the Prometheus server.
+
+Strimzi provides example custom resource configuration YAML files with relabeling rules.
+When deploying Prometheus metrics configuration, you can deploy the example custom resource or copy the metrics configuration to your own custom resource definition.
+
+//Example Prometheus JMX metrics files
+include::../../modules/metrics/ref-prometheus-jmx-metrics-config.adoc[leveloffset=+1]
+//Example Strimzi metrics reporter files
+include::../../modules/metrics/ref-strimzi-metrics-reporter-config.adoc[leveloffset=+1]
 //Example Prometheus alert rules
 include::../../modules/metrics/ref_metrics-alertmanager-examples.adoc[leveloffset=+1]
 //Example Grafana dashboards

documentation/assemblies/metrics/assembly-metrics.adoc

@@ -21,7 +21,7 @@ Strimzi provides example Prometheus rules and Grafana dashboards, which you can
 These tools help visualize metrics and define alerts based on specific conditions.
 Additionally, you can configure your deployment to track messages end-to-end by xref:assembly-distributed-tracing-str[setting up distributed tracing].
 
-NOTE: Strimzi provides example installation files for Prometheus and Grafana to help get you started. 
+NOTE: Strimzi provides example installation files for Prometheus and Grafana to help get you started.
 For further support, refer to the Prometheus and Grafana developer communities.
 
 .Supporting documentation for metrics and monitoring tools

documentation/assemblies/metrics/assembly_metrics-prometheus-setup.adoc

@@ -12,16 +12,23 @@ To expose metrics in Prometheus format, you add configuration to a custom resour
 You must also make sure that the metrics are scraped by your monitoring stack.
 Prometheus and Prometheus Alertmanager are used in the examples provided by Strimzi, but you can use also other compatible tools.
 
-Using Prometheus with Strimzi, requires the following:
+You can expose metrics using one of the following approaches:
+
+* xref:proc-jmx-exporter-metrics-kafka-deploy-options-{context}[Enabling Prometheus JMX Exporter]
+
+* xref:proc-metrics-reporter-kafka-deploy-options-{context}[Enabling Strimzi Metrics Reporter]
+
+After enabling metrics, you can integrate with Prometheus:
 
-. xref:proc-metrics-kafka-deploy-options-{context}[Enabling Prometheus metrics through configuration]
 . xref:assembly-metrics-prometheus-{context}[Setting up Prometheus]
 . xref:proc-metrics-deploying-prometheus-alertmanager-{context}[Deploying Prometheus Alertmanager]
 
 Strimzi provides an xref:assembly-metrics-config-files-str[example Grafana dashboards] to display visualizations of metrics.
 The exposed metrics provide the monitoring data when you xref:proc-metrics-grafana-dashboard-str[enable the Grafana dashboard].
 
-include::../../modules/metrics/proc-metrics-kafka-deploy-options.adoc[leveloffset=+1]
+include::../../modules/metrics/proc-jmx-exporter-metrics-kafka-deploy-options.adoc[leveloffset=+1]
+
+include::../../modules/metrics/proc-strimzi-metrics-reporter-kafka-deploy-options.adoc[leveloffset=+1]
 
 include::assembly_metrics-prometheus-deploy.adoc[leveloffset=+1]
 

…s/proc-metrics-kafka-deploy-options.adoc …porter-metrics-kafka-deploy-options.adocdocumentation/modules/metrics/proc-metrics-kafka-deploy-options.adoc renamed to documentation/modules/metrics/proc-jmx-exporter-metrics-kafka-deploy-options.adoc documentation/modules/metrics/proc-metrics-kafka-deploy-options.adoc renamed to documentation/modules/metrics/proc-jmx-exporter-metrics-kafka-deploy-options.adoc

@@ -2,8 +2,8 @@
 //
 // metrics/assembly_metrics-kafka.adoc
 
-[id='proc-metrics-kafka-deploy-options-{context}']
-= Enabling Prometheus metrics through configuration
+[id='proc-jmx-exporter-metrics-kafka-deploy-options-{context}']
+= Enabling Prometheus JMX Exporter
 
 [role="_abstract"]
 To enable and expose metrics in Strimzi for Prometheus, configure the appropriate properties in the custom resources for the components you want to monitor.
@@ -39,7 +39,7 @@ You can create your own Prometheus configuration or use the xref:ref-metrics-pro
 * `kafka-cruise-control-metrics.yaml`
 * `oauth-metrics.yaml`
 
-These files include relabeling rules and example metrics configuration, and are a good starting point for trying Prometheus with Strimzi. 
+These files include relabeling rules and example metrics configuration, and are a good starting point for trying Prometheus with Strimzi.
 
 This procedure shows how to deploy example Prometheus metrics configuration to the `Kafka` resource.
 The same steps apply when deploying the example files for other resources.

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

@@ -0,0 +1,64 @@
+// This assembly is included in the following assemblies:
+//
+// metrics/assembly_metrics-kafka.adoc
+
+[id='proc-metrics-reporter-kafka-deploy-options-{context}']
+= Enabling Strimzi Metrics Reporter
+
+[role="_abstract"]
+To enable and expose metrics in Strimzi for Prometheus, configure the appropriate properties in the custom resources for the components you want to monitor.
+
+Use `metricsConfig` configuration to expose metrics for these components:
+
+* Kafka
+
+This enables the {StrimziMetricsReporter}, which exposes metrics on port 9404 through an HTTP endpoint.
+Prometheus scrapes this endpoint to collect Kafka metrics.
+
+You can create your own Prometheus configuration or use the xref:ref-metrics-prometheus-metrics-config-{context}[example custom resource file] provided with Strimzi:
+
+* `kafka-metrics.yaml`
+
+This file contains the necessary configuration, and is a good starting point for trying Prometheus with Strimzi.
+
+This procedure shows how to deploy example Prometheus metrics configuration to the `Kafka` resource.
+
+.Procedure
+
+. Deploy the example custom resource with the Prometheus configuration.
++
+For example, for each `Kafka` resource you can apply the `kafka-metrics.yaml` file.
++
+.Deploying the example configuration
+[source,shell,subs="+attributes"]
+----
+kubectl apply -f kafka-metrics.yaml
+----
++
+Alternatively, copy the example configuration in `kafka-metrics.yaml` to your own `Kafka` resource.
++
+.Copying the example configuration
+[source,shell]
+----
+kubectl edit kafka <kafka_configuration_file>
+----
++
+Copy the `metricsConfig` property to your `Kafka` resource.
++
+.Example metrics configuration for Kafka
+[source,yaml,subs="+quotes,attributes"]
+----
+apiVersion: {KafkaApiVersion}
+kind: Kafka
+metadata:
+  name: my-cluster
+spec:
+  kafka:
+    # ...
+    metricsConfig:
+      type: strimziMetricsReporter
+      values:
+        allowList:
+          - "kafka_log.*"
+          - "kafka_network.*"
+----

documentation/modules/metrics/proc_metrics-grafana-dashboard.adoc

@@ -29,7 +29,8 @@ When accessing a dashboard, you can use the `port-forward` command to forward tr
 The name of the Grafana pod is different for each user.
 
 .Prerequisites
-* xref:proc-metrics-kafka-deploy-options-{context}[Metrics are configured for the Kafka cluster resource]
+* xref:proc-jmx-exporter-metrics-kafka-deploy-options-{context}[Prometheus JMX Exporter metrics are configured for the Kafka cluster resource]
+* xref:proc-strimzi-metrics-reporter-kafka-deploy-options.adoc-{context}[Strimzi Metrics Reporter metrics are configured for the Kafka cluster resource]
 * xref:assembly-metrics-prometheus-{context}[Prometheus and Prometheus Alertmanager are deployed]
 
 .Procedure

…trics/ref-prometheus-metrics-config.adoc …s/ref-prometheus-jmx-metrics-config.adocdocumentation/modules/metrics/ref-prometheus-metrics-config.adoc renamed to documentation/modules/metrics/ref-prometheus-jmx-metrics-config.adoc documentation/modules/metrics/ref-prometheus-metrics-config.adoc renamed to documentation/modules/metrics/ref-prometheus-jmx-metrics-config.adoc

@@ -3,22 +3,18 @@
 //
 // metrics/assembly-metrics-config-files.adoc
 
-[id='ref-metrics-prometheus-metrics-config-{context}']
+[id='ref-jmx-metrics-prometheus-metrics-config-{context}']
 
-= Example Prometheus metrics configuration
+= Example Prometheus JMX Exporter metrics configuration
 
 [role="_abstract"]
-Strimzi uses the {JMXExporter} to expose metrics through an HTTP endpoint, which can be scraped by the Prometheus server.
 
-Grafana dashboards are dependent on Prometheus JMX Exporter relabeling rules, which are defined for Strimzi components in the custom resource configuration.
+Grafana dashboards with Prometheus JMX Exporter are dependent on relabeling rules, which are defined for Strimzi components in the custom resource configuration.
 
 A label is a name-value pair.
 Relabeling is the process of writing a label dynamically.
 For example, the value of a label may be derived from the name of a Kafka server and client ID.
 
-Strimzi provides example custom resource configuration YAML files with relabeling rules.
-When deploying Prometheus metrics configuration, you can can deploy the example custom resource or copy the metrics configuration to your own custom resource definition.
-
 .Example custom resources with metrics configuration
 [cols="3*",options="header",stripes="none"]
 |===

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

@@ -0,0 +1,22 @@
+
+// This assembly is included in the following assemblies:
+//
+// metrics/assembly-metrics-config-files.adoc
+
+[id='ref-metrics-reporter-config-{context}']
+
+= Example Metrics Reporter metrics configuration
+[role="_abstract"]
+
+.Example custom resources with metrics configuration
+[cols="3*",options="header",stripes="none"]
+|===
+|Component
+|Custom resource
+|Example YAML file
+
+|Kafka nodes
+|`Kafka`
+|`kafka-metrics.yaml`
+
+|===