Fix typos and formatting

Signed-off-by: Federico Valeri <[email protected]>

090-integrate-bridge-with-metrics-reporter.md

@@ -5,20 +5,19 @@ This is a Kafka MetricsReporter plugin that directly exposes metrics in Promethe
 
 ## Current situation
 
-The HTTP Bridge allow users to enable or disable the metrics endpoint using the `KAFKA_BRIDGE_METRICS_ENABLED` environment variable.
+The HTTP Bridge allows users to enable or disable the metrics endpoint using the `KAFKA_BRIDGE_METRICS_ENABLED` environment variable.
 When this variable is set to true, the Bridge creates the JMX Exporter's JmxCollector class with hard coded configuration.
-This configuration is a JMX metrics exporter YAML distributed as an embedded resource within the Bridge JAR file.
+This configuration is a JMX metrics exporter YAML distributed as an embedded resource within the Bridge's JAR file.
 
-When deploying the Bridge through the Cluster Operator, a similar configuration is available in the KafkaBridge CRD:
+When deploying the Bridge through the Cluster Operator, a similar configuration is available in the KafkaBridge's CRD:
 
 ```sh
 spec:
   enableMetrics: true
 ```
 
-This is different from how the metrics endpoint is enabled in all the other major components deployed bu the Cluster Operator.
+This is different from how the metrics endpoint is enabled in all the other major components deployed by the Cluster Operator.
 The Cluster Operator exposes metrics through the [Prometheus JMX Exporter](https://github.com/prometheus/jmx_exporter), which can be configured using the shared `metricsConfig` schema.
-
 This schema has a type property that only allows the `jmxPrometheusExporter` value, and a reference to a ConfigMap containing its configuration:
 
 ```sh
@@ -30,27 +29,26 @@ metricsConfig:
       key: metrics-config.yml
 ```
 
-At runtime, this configuration enables a Java agent that exposes Kafka JMX metrics in Prometheus format through an HTTP endpoint on port 9404.
+At runtime, the above configuration enables a Java agent which exposes Kafka JMX metrics in Prometheus format through an HTTP endpoint on port 9404.
 Note that this agent depends on the [Kafka JMX Reporter](https://github.com/apache/kafka/blob/3.9.0/clients/src/main/java/org/apache/kafka/common/metrics/JmxReporter.java) plugin, which is enabled by default.
 
 ## Motivation
 
-We want to support the Strimzi Reporter as an alternative way of configuring metrics across all components.
+We want to support the Strimzi Metrics Reporter as an alternative way of configuring metrics across all components.
 When deploying configuring major components through the Cluster Operator, we want to provide a consistent user experience, so the Bridge should also support the `metricsConfig` schema. 
 
 ## Proposal
 
-The Bridge will support both JMX Exporter and Strimzi Reporter as metrics configuration types.
-It will also provide new configurations for the integration with the Cluster Operator.
+The Bridge will support both JMX Prometheus Exporter and Strimzi Metrics Reporter as metrics configuration types.
+It will also provide new configurations for the integration with Cluster Operator.
 
 ### Metrics configuration types
 
-The Bridge project will be updated to support multiple types of metrics configurations.
+The Bridge project will be updated to support multiple metrics configurations types.
 A new `bridge.metrics` property will be available within the application.properties configuration file, and will only accept `jmxPrometheusExporter` and `strimziMetricsReporter`.
 Any other value will raise an error and the application will fail to start with an appropriate error message.
 
-When running in standalone mode with `strimziMetricsReporter`, the user will be able to configure any Strimzi Reporter property using the "kafka." prefix.
-
+When running in standalone mode with `strimziMetricsReporter`, the user will be able to configure any reporter property using the "kafka." prefix.
 The following example will be provided as a comment in the default application.properties file:
 
 ```sh
@@ -65,19 +63,18 @@ When set, the user will get a warning suggesting to use the `bridge.metrics` pro
 In case they are both set, `bridge.metrics` will take precedence over `KAFKA_BRIDGE_METRICS_ENABLED`.
 
 The MetricsReporter class will be updated to also include a new StrimziCollectorRegistry that will work similarly to the JmxCollectorRegistry.
-The StrimziCollectorRegistry will include a reference to PrometheusRegistry.defaultRegistry, which is the same instance used by the Strimzi Reporter to collect metrics.
+The StrimziCollectorRegistry will include a reference to PrometheusRegistry.defaultRegistry, which is the same instance used by the Strimzi Metrics Reporter to collect metrics.
 
 The kafka_bridge_config_generator.sh script is used to generate the image configuration based on environment variables.
-This script will be updated to also include `bridge.metrics` and related configurations (see the following section).
+This script will be also updated to include `bridge.metrics` and related configurations (see the following section).
 
-The Bridge will try to load the JMX Exporter configuration file from the path specified by the `bridge.metrics.jmx.exporter.config.path` property.
+The Bridge will try to load the JMX Prometheus Exporter configuration file from the path specified by the `bridge.metrics.jmx.exporter.config.path` property.
 If the property is not specified or the file is not found, the Bridge will fall back to the hard coded configuration.
-This feature is not strictly required for the Strimzi Reporter support, but will be used by the Cluster Operator.
-
-### Cluster Operator deploy
+This feature is not strictly required to support the Strimzi Metrics Reporter, but will be used by the Cluster Operator.
 
-Like the other major components, the KafkaBridge CRD will also support `metricsConfig` with support for `strimziMetricsReporter` type.
+### Cluster Operator integration
 
+The KafkaBridge's CRD will also support `metricsConfig` with the addition of `strimziMetricsReporter` type.
 This is how the Strimzi Reporter configuration will look like:
 
 ```sh
@@ -93,28 +90,28 @@ spec:
 Three new environment variables will be introduced to pass the metrics configuration to the Bridge's container:
 
 - `STRIMZI_METRICS`: This will contain the `metricsConfig` types to enable (one of `jmxPrometheusExporter` and `strimziMetricsReporter`).
-- `KAFKA_BRIDGE_METRICS_JMX_CONFIG`: Used with JMX Exporter to pass the configuration file path.
-- -`KAFKA_BRIDGE_METRICS_SMR_CONFIG`: Used with Strimzi Reporter to pass the plugin configuration.
+- `KAFKA_BRIDGE_METRICS_JMX_CONFIG`: Used with JMX Prometheus Exporter to pass the configuration file path.
+- `KAFKA_BRIDGE_METRICS_SMR_CONFIG`: Used with Strimzi Metrics Reporter to pass the plugin configuration.
 
 The `enableMetrics` property will be deprecated and removed in a future release.
 When set, the user will get a warning suggesting to use the `metricsConfig` configuration.
 In case they are both set, `metricsConfig` will take precedence over `enableMetrics`.
 
-The JMX Exporter configuration file will be stored in a ConfigMap and mounted in the Bridge container.
-The full configuration file passed to the Bridge container will be `/opt/strimzi/custom-config/metrics-config.yml`.
+The JMX Prometheus Exporter configuration file will be stored in a ConfigMap and mounted in the Bridge's container.
+The full configuration file passed to the Bridge's container will be `/opt/strimzi/custom-config/metrics-config.yml`.
 
-Metrics will be exposed through the Bridge HTTP server, so the Strimzi Reporter's listener will be disabled.
+Metrics will be exposed through the Bridge's HTTP server, so the Strimzi Metrics Reporter's listener will be disabled.
 Other configurations will be locked down with the exception of the `prometheus.metrics.reporter.allowlist` property.
 
 ## Affected/not affected projects
 
-The only affected projects are Cluster Operator and Kafka Bridge.
+The affected projects are Cluster Operator and Kafka Bridge.
 
 ## Compatibility
 
 All changes will be backwards compatible, but there will be some deprecations as detailed above.
 
 ## Rejected alternatives
 
-Lock down and automate the Strimzi Reporter configurations for the standalone Bridge.
-Historically, the Bridge allows user to customize Kafka clients and plugins using its properties file and providing commented examples.
+Lock down and automate the Strimzi Metrics Reporter configurations for the standalone Bridge.
+This wa rejected because, historically, the Bridge allows user to customize Kafka clients and plugins using the application.properties file, which includes commented examples.