Skip to content
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

KAFKA-15669: Implement telemetry metric naming strategy (KIP-714) #14619

Merged
merged 4 commits into from
Oct 31, 2023

Conversation

apoorvmittal10
Copy link
Collaborator

@apoorvmittal10 apoorvmittal10 commented Oct 23, 2023

The PR defines the naming convention for telemetry metric names for KIP-714 - jira. Telemetry metric name should be dot separated and tags should be snake case.

PR adds the interface which will be used in MetricsReporter implementation to construct metric names.

Committer Checklist (excluded from commit message)

  • Verify design and implementation
  • Verify test coverage and CI build status
  • Verify documentation (including upgrade notes)

@apoorvmittal10
Copy link
Collaborator Author

Depends on PR - #14575 for build.

@mjsax mjsax added core Kafka Broker kip Requires or implements a KIP labels Oct 27, 2023
* This class encapsulates naming and mapping conventions defined as part of
* <a href="https://cwiki.apache.org/confluence/display/KAFKA/KIP-714%3A+Client+metrics+and+observability#KIP714:Clientmetricsandobservability-Metricsnamingandformat">Metrics naming and format</a>
*/
public class MetricNamingConvention {
Copy link
Member

Choose a reason for hiding this comment

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

maybe a more explicit class name would help here. Since the goal of this mapping is to map the metric names to something that fits OpenTelemetry conventions, maybe we can call this OpenTelemetryMetricNamingConvention ?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

I have changed name to TelemtryMetricNamingConvention as we generally referred by same in KIP. Let me know if it works or we still feel that the name should be more specific as you suggested.

@wcarlson5
Copy link
Contributor

The tests failing are not related to this PR

@wcarlson5 wcarlson5 merged commit ed3fa83 into apache:trunk Oct 31, 2023
1 check failed
yyu1993 pushed a commit to yyu1993/kafka that referenced this pull request Feb 15, 2024
…ache#14619)

The PR defines the naming convention for telemetry metric names for KIP-714 - jira. Telemetry metric name should be dot separated and tags should be snake case.

PR adds the interface which will be used in MetricsReporter implementation to construct metric names.

Reviewers: Xavier Léauté <[email protected]>, Walker Carlson <[email protected]>, Matthias J. Sax <[email protected]>, Andrew Schofield <[email protected]>
AnatolyPopov pushed a commit to aiven/kafka that referenced this pull request Feb 16, 2024
…ache#14619)

The PR defines the naming convention for telemetry metric names for KIP-714 - jira. Telemetry metric name should be dot separated and tags should be snake case.

PR adds the interface which will be used in MetricsReporter implementation to construct metric names.

Reviewers: Xavier Léauté <[email protected]>, Walker Carlson <[email protected]>, Matthias J. Sax <[email protected]>, Andrew Schofield <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Kafka Broker kip Requires or implements a KIP
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants