apache / apache/druid

Add @MetricsApi annotation

Open
#7,478 3 comments 0 reactions 0 assignees View on GitHub
Evergreen Improvement Stable API
Dominant language
Java
Stars
14.1k
Forks
3.8k
Avg merge
2d 58m
Merged PRs (30d)
233

Description

I addition to `@PublicApi`, it would be useful to annotate string literals and enum constant names which leak into emitted metrics, and thus cannot be safely renamed without compatibility bridges.

Examples: most constants in `DruidMetrics` class.

Contributor guide

Open the contributing guide

Research direction

Start by reading the existing @PublicApi annotation and the constants in DruidMetrics. Determine how a new @MetricsApi annotation should identify string literals and enum constant names that are emitted as metrics, then verify that the annotated names retain compatibility when renamed.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
observability-sre
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.