Skip to content

Docs integreate strimzi metrics reporter kc mm2 #11575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

OwenCorrigan76
Copy link
Contributor

Type of change

  • Documentation

Description

With newly added support for the Strimzi Metrics Reporter to KafkaConnect and MirrorMaker2, this PR updates the assemblies and modules documents to reflect the changes in the way we can deploy metrics to the KafkaConnect and MirrorMaker2.

Updates:

  • Example metrics files
  • Example grafana dashboards – mentioning metrics reporter-specific grafana dashboards

Structure for new content:

  • Assembly file: Using Metrics Reporter with Strimzi
  • Procedure file: Enabling Metrics Reporter
  • Reference file: Example Metrics Reporter configuration

Related to #11051

Checklist

Please go through this checklist and make sure all applicable tasks have been done

  • Write tests
  • Make sure all tests pass
  • Update documentation
  • Check RBAC rights for Kubernetes / OpenShift roles
  • Try your changes from Pod inside your Kubernetes and OpenShift cluster, not just locally
  • Reference relevant issue(s) and close them after merging
  • Update CHANGELOG.md
  • Supply screenshots for visual changes, such as Grafana dashboards

Signed-off-by: OwenCorrigan76 <owencorrigan76@gmail.com>
@OwenCorrigan76 OwenCorrigan76 force-pushed the Docs_Integreate_Strimzi_Metrics_Reporter_KC_MM2 branch from 6629638 to 9ae03f5 Compare June 23, 2025 14:46
Signed-off-by: OwenCorrigan76 <owencorrigan76@gmail.com>
@@ -41,15 +41,19 @@ metrics
│ └── strimzi-pod-monitor.yaml <9>
├── strimzi-metrics-reporter
| ├── grafana-dashboards <10>
| | ├── strimzi-kafka.json
| | ├── strimzi-kafka.json|
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| | ├── strimzi-kafka.json|
| | ├── strimzi-kafka.json

@fvaleri fvaleri added this to the 0.47.0 milestone Jun 26, 2025
@PaulRMellor PaulRMellor self-requested a review June 26, 2025 08:00
Copy link
Contributor

@PaulRMellor PaulRMellor left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Owen. Looks good.
You asked about whether to include example config for Connect/MM2 in 25.2.2. Enabling Strimzi Metrics Reporter.
I don't think so. The config is the same.

Comment on lines +69 to +71
<11> Resource for deploying and configuring Strimzi Metrics Reporter based KafkaConnect.
<12> Resource for deploying and configuring Strimzi Metrics Reporter based MirrorMaker2.
<13> Resource for deploying and configuring Strimzi Metrics Reporter based Kafka.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
<11> Resource for deploying and configuring Strimzi Metrics Reporter based KafkaConnect.
<12> Resource for deploying and configuring Strimzi Metrics Reporter based MirrorMaker2.
<13> Resource for deploying and configuring Strimzi Metrics Reporter based Kafka.
<11> `KafkaConnect` resource for deploying Kafka Connect with Strimzi Metrics Reporter.
<12> `KafkaMirrorMaker2` resource for deploying MirrorMaker 2 with Strimzi Metrics Reporter.
<13> `Kafka` resource for deploying Kafka with Strimzi Metrics Reporter.

Comment on lines 22 to +24
* `kafka-metrics.yaml`
* `kafka-connect-metrics.yaml`
* `kafka-mirror-maker-2-metrics.yaml`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

would it help to put the containing folder here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hey @PaulRMellor. I don't quite get you. Do you mean add the containing examples folder to the PR or something else? The updated folder will be part of the integration PR which will be merged before this I reckon.
This is the structure that the folder will take:

├── strimzi-metrics-reporter
|    ├── grafana-dashboards (10)
|    |  ├── strimzi-kafka.json
|    |  ├── strimzi-kafka-connect.json
|    |  ├── strimzi-kafka-mirror-maker-2.json
|    |  ├── strimzi-kraft.json
│    ├── kafka-connect-metrics.yaml (11)
│    ├── kafka-metrics.yaml (12)
|    └── kafka-mirror-maker-2-metrics.yaml (13)

Thanks

@scholzj scholzj modified the milestones: 0.47.0, 0.48.0 Jul 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants