Versions Compared

Old Version 13

changes.mady.by.user Ken Huang

Saved on

compared with

New Version 14

changes.mady.by.user Ken Huang

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Status

Current state: "Under Discussion"

Discussion thread: here

JIRA:

Jira
serverASF JIRA
columnIdsissuekey,summary,issuetype,created,updated,duedate,assignee,reporter,customfield_12311032,customfield_12311037,customfield_12311022,customfield_12311027,priority,status,resolution
columnskey,summary,type,created,updated,due,assignee,reporter,Priority,Priority,Priority,Priority,priority,status,resolution
serverId5aa69414-a9e9-3523-82ec-879b028fb15b
keyKAFKA-17876

Motivation

The metrics were originally named in the `kafka.<COMPONENT>` format but were unexpectedly altered when we moved Java classes from the `kafka.server` package to the `org.apache.kafka.server` package as part of [commit](3.7).

Subsequent developers didn’t notice this change and began using the new package name as the `metricName`. The correct naming should actually revert to `kafka.<COMPONENT>`.

This KIP aims to standardize Kafka metric naming by updating the `org.apache.kafka.server:type=AssignmentsManager` metric to follow the `kafka.<COMPONENT>` convention used by other Kafka metrics.

Public Interface

  • org.apache.kafka.server.AssignmentsManager

Proposed Changes

Rename the `org.apache.kafka.server:type=AssignmentsManager` metric to `kafka.server:type=AssignmentsManager`.

This change will impact external monitoring systems that rely on this metric, and corresponding modifications will be needed to support the new name.

Compatibility, Deprecation, and Migration Plan

  1. We will add a deprecated annotation on `AssignmentsManager#QUEUED_REPLICA_TO_DIR_ASSIGNMENTS_METRIC`.
  2. Add new `AssignmentsManager#QUEUED_REPLICA_TO_DIR_ASSIGNMENTS_METRIC_NAME` which `metricName` is `kafka.server:type=AssignmentsManager`  and add it to `AssignmentsManager#metricsRegistry`.
  3. Delete `AssignmentsManager#QUEUED_REPLICA_TO_DIR_ASSIGNMENTS_METRIC` at the next major release and remove it from `AssignmentsManager#metricsRegistry`.

Test Plan

  • We should add new test for new metrics works expected as deprecated test.

Rejected Alternatives

n/a