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

Add display name to Metric Enum #4988

Open
dlmarion opened this issue Oct 16, 2024 · 3 comments · May be fixed by #5346
Open

Add display name to Metric Enum #4988

dlmarion opened this issue Oct 16, 2024 · 3 comments · May be fixed by #5346
Labels
enhancement This issue describes a new feature, improvement, or optimization.
Milestone

Comments

@dlmarion
Copy link
Contributor

Add a display name that can be used by the Monitor

@dlmarion dlmarion added the enhancement This issue describes a new feature, improvement, or optimization. label Oct 16, 2024
@dlmarion dlmarion added this to the 4.0.0 milestone Oct 16, 2024
@Suvrat1629
Copy link
Contributor

So I need to add a new displayName field to the Metric constructor and then update all the enum values. Is this approach right? Do I need to look into any more files?

@Suvrat1629
Copy link
Contributor

@dlmarion Please could you confirm my approach from the previous comment. I am willing to work on this issue. Thank you:)

@dlmarion
Copy link
Contributor Author

Yes, if you are not familiar with this issue, then here is some background. There is a plugin that runs during the build (mvn clean package should be enough to do it) that will generate the file core/target/generated-docs/metrics3.md. This markdown file at some point will be copied over to the accumulo-website repository (see apache/accumulo-website#442 for example). I'm proposing that we add a display name (e.g. Server Low Memory Indicator) instead of the metric name accumulo.detected.low.memory at the start of each metric. We should include the metric name in the body of each section. The plugin may need to be modified as well to use the display name as the title and to put the metric name in the body of each metric.

@DomGarguilo wrote the plugin I believe, so he should be able to answer questions about this as well.

@Suvrat1629 Suvrat1629 linked a pull request Feb 21, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement This issue describes a new feature, improvement, or optimization.
Projects
Status: No status
Development

Successfully merging a pull request may close this issue.

2 participants