8000 feat(inkless:metrics): add inkless-tag and kafka-version to app-info [KC-595] by jeqo · Pull Request #821 · aiven/inkless · GitHub
[go: up one dir, main page]

Skip to content

feat(inkless:metrics): add inkless-tag and kafka-version to app-info [KC-595] - #821

Merged
gqmelo merged 1 commit into
mainfrom
jeqo/inkless-tag-metric
Oct 15, 2026
Merged

gqmelo merged 1 commit into
mainfrom
jeqo/inkless-tag-metric

Conversation

@jeqo
@jeqo jeqo commented Oct 12, 2026 •
Copy link
Copy Markdown
Contributor

Operators can read the Inkless release tag of a running broker or client from the app-info metric group and the AppInfo MBean, next to version and commit-id.

  • inkless-tag: the git describe output of the nearest inkless-* tag, such as inkless-4.2.1-0.45. A build can set the value with -PinklessTag, which takes precedence over git. Without -PinklessTag, the value is unknown when the build has no git checkout or git can't describe it (git is unavailable or there is no HEAD). On a checkout with no matching inkless-* tag, the value is the abbreviated commit hash, because determineInklessTag() uses git describe --always. That behavior is unchanged by this PR.
  • kafka-version: the upstream Kafka version, derived by removing the -inkless qualifier from version, such as 4.3.1 for 4.3.1-inkless. A -SNAPSHOT suffix is kept. Dashboards and upgrade checks that compare against upstream Kafka need the plain version.

Both are also available as the InklessTag and KafkaVersion attributes of the AppInfo MBean. The new metrics are documented in docs/inkless/FEATURES.md.

@jeqo
jeqo force-pushed the jeqo/inkless-tag-metric branch from 7d9bb23 to 62a9e69 Compare October 12, 2026 10:06
@jeqo jeqo changed the title feat(inkless:metrics): add inkless-tag and kafka-version to app-info feat(inkless:metrics): add inkless-tag and kafka-version to app-info [KC-595] Oct 12, 2026
@jeqo
jeqo requested a balanced review from Copilot October 12, 2026 10:15
Copilot AI left a comment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

Untagged Git checkouts expose a commit hash instead of the documented unknown value.

3 open findings
What changed in this PR

Adds Inkless release and upstream Kafka version metadata to application metrics and JMX.

Changes:

  • Adds inkless-tag and kafka-version gauges and MBean attributes.
  • Derives the upstream Kafka version from the Inkless version.
  • Adds documentation and tests.
File Description
AppInfoParser.java Registers and exposes the new version metadata.
AppInfoParserTest.java Tests metric lifecycle and version derivation.
FEATURES.md Documents the new gauges and MBean attributes.

🧠 Review effort: Balanced


💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.

@jeqo
jeqo force-pushed the jeqo/inkless-tag-metric branch from 62a9e69 to 30200bc Compare October 12, 2026 10:34
@jeqo
jeqo requested a balanced review from Copilot October 12, 2026 10:35
Copilot AI left a comment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The documented commit-hash fallback contradicts the PR description’s operator-facing contract.

1 open finding
3 resolved since last review

🧠 Review effort: Balanced

Comment thread docs/inkless/FEATURES.md Resolved
@jeqo
jeqo requested a balanced review from Copilot October 12, 2026 10:46
Copilot AI left a comment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The documentation incorrectly omits the supported -PinklessTag override from its fallback contract.

2 open findings

🧠 Review effort: Balanced

Comment thread docs/inkless/FEATURES.md Resolved
@jeqo
jeqo force-pushed the jeqo/inkless-tag-metric branch from 30200bc to c4446a9 Compare October 12, 2026 10:51
@jeqo
jeqo requested a balanced review from Copilot October 12, 2026 10:51
Copilot AI left a comment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟡 Changes recommended

The added documentation must follow the repository's mandatory active-voice convention.

2 open findings
1 resolved since last review

🧠 Review effort: Balanced

Comment thread docs/inkless/FEATURES.md Resolved
Operators can read the Inkless release tag of a running broker or client from the app-info metric group and the AppInfo MBean, next to version and commit-id. The inkless-tag value is unknown when the build has no Inkless tag.

The version metric carries the full Inkless version, such as 4.3.1-inkless. Dashboards and upgrade checks that compare against upstream Kafka need the plain 4.3.1. AppInfo also exposes kafka-version, derived by removing the -inkless qualifier, and keeps any -SNAPSHOT suffix.

Assisted-by: Claude Sonnet 5.5
@jeqo
jeqo force-pushed the jeqo/inkless-tag-metric branch from c4446a9 to 7c61837 Compare October 12, 2026 11:04
@jeqo
jeqo requested a balanced review from Copilot October 12, 2026 11:04
Copilot AI left a comment
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

🟢 Approval recommended

The implementation, tests, and documentation consistently provide the stated metadata.

1 open finding
1 resolved since last review

🧠 Review effort: Balanced

@jeqo
jeqo marked this pull request as ready for review October 12, 2026 11:10
@jeqo
jeqo requested a review from gqmelo October 15, 2026 08:56
@gqmelo
gqmelo merged commit cfdb7fa into main Oct 15, 2026
13 checks passed
@gqmelo
gqmelo deleted the jeqo/inkless-tag-metric branch October 15, 2026 12:58
jeqo added a commit that referenced this pull request Oct 19, 2026
…821)

Operators can read the Inkless release tag of a running broker or client from the app-info metric group and the AppInfo MBean, next to version and commit-id. The inkless-tag value is unknown when the build has no Inkless tag.

The version metric carries the full Inkless version, such as 4.3.1-inkless. Dashboards and upgrade checks that compare against upstream Kafka need the plain 4.3.1. AppInfo also exposes kafka-version, derived by removing the -inkless qualifier, and keeps any -SNAPSHOT suffix.

Assisted-by: Claude Sonnet 5.5
jeqo added a commit that referenced this pull request Oct 19, 2026
…821)

Operators can read the Inkless release tag of a running broker or client from the app-info metric group and the AppInfo MBean, next to version and commit-id. The inkless-tag value is unknown when the build has no Inkless tag.

The version metric carries the full Inkless version, such as 4.3.1-inkless. Dashboards and upgrade checks that compare against upstream Kafka need the plain 4.3.1. AppInfo also exposes kafka-version, derived by removing the -inkless qualifier, and keeps any -SNAPSHOT suffix.

Assisted-by: Claude Sonnet 5.5
jeqo added a commit that referenced this pull request Oct 19, 2026
…821)

Operators can read the Inkless release tag of a running broker or client from the app-info metric group and the AppInfo MBean, next to version and commit-id. The inkless-tag value is unknown when the build has no Inkless tag.

The version metric carries the full Inkless version, such as 4.3.1-inkless. Dashboards and upgrade checks that compare against upstream Kafka need the plain 4.3.1. AppInfo also exposes kafka-version, derived by removing the -inkless qualifier, and keeps any -SNAPSHOT suffix.

Assisted-by: Claude Sonnet 5.5
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.

3 participants

0