Skip to content

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

@OwenCorrigan76 OwenCorrigan76 force-pushed the Docs_Integreate_Strimzi_Metrics_Reporter_KC_MM2 branch from 6629638 to 9ae03f5 Compare June 23, 2025 14:46
├── 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
@fvaleri
Copy link
Contributor

fvaleri commented Jul 31, 2025

@OwenCorrigan76 is this ready to be reviewed? Now that KC and MM2 integration is merged, it would be good to also get this one.

@fvaleri fvaleri self-requested a review July 31, 2025 06:57
@OwenCorrigan76
Copy link
Contributor Author

I have another commit that I will push shortly. Then it can be reviewd. Thanks @fvaleri

@OwenCorrigan76 OwenCorrigan76 force-pushed the Docs_Integreate_Strimzi_Metrics_Reporter_KC_MM2 branch 7 times, most recently from d243797 to 5dc84a6 Compare August 1, 2025 09:47
This patch adds trimzi Metrics Reporter integration with KC and MM2.

Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: Federico Valeri <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: Federico Valeri <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: Federico Valeri <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: Federico Valeri <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: Federico Valeri <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: Federico Valeri <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: Federico Valeri <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: Federico Valeri <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: OwenCorrigan76 <[email protected]>
@OwenCorrigan76 OwenCorrigan76 force-pushed the Docs_Integreate_Strimzi_Metrics_Reporter_KC_MM2 branch from 5dc84a6 to 5fe2d59 Compare August 1, 2025 09:51
@OwenCorrigan76 OwenCorrigan76 marked this pull request as ready for review August 1, 2025 12:01
Copy link
Contributor

@fvaleri fvaleri left a comment

Choose a reason for hiding this comment

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

Thanks.

@OwenCorrigan76 OwenCorrigan76 removed the request for review from PaulRMellor August 1, 2025 13:04
@fvaleri
Copy link
Contributor

fvaleri commented Aug 1, 2025

@scholzj now that related feature is merged, can you also have another look at this one?

@scholzj scholzj merged commit 7b70c14 into strimzi:main Aug 1, 2025
13 checks passed
see-quick pushed a commit to see-quick/strimzi-kafka-operator that referenced this pull request Sep 4, 2025
Signed-off-by: OwenCorrigan76 <[email protected]>
Signed-off-by: Federico Valeri <[email protected]>
@OwenCorrigan76 OwenCorrigan76 deleted the Docs_Integreate_Strimzi_Metrics_Reporter_KC_MM2 branch November 25, 2025 09:27
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