apache / apache/fluss

[Build][Docs] Generate list of metrics in docs from source code

Open
#1,173 3 comments 0 reactions 0 assignees View on GitHub
Dominant language
Java
Stars
2.1k
Forks
625
Avg merge
3d 14h
Merged PRs (30d)
97

Description

### Search before asking

- [x] I searched in the [issues](https://github.com/alibaba/fluss/issues) and found nothing similar.

### Motivation

Generate Fluss-specific metrics [in the documentation](https://alibaba.github.io/fluss-docs/docs/maintenance/observability/monitor-metrics/#metrics-list) from the source code (`src/main/java/com/alibaba/fluss/metrics/MetricNames.java`).

### Solution

_No response_

### Anything else?

_No response_

### Willingness to contribute

- [ ] I'm willing to submit a PR!

Contributor guide

No contributing guide indexed for this repository

Research direction

Start with src/main/java/com/alibaba/fluss/metrics/MetricNames.java and compare its metrics with the documentation's metrics list at docs/maintenance/observability/monitor-metrics/#metrics-list. Determine how the list can be generated from the source, then verify that the documentation reflects the source-defined metrics and remains suitable for the existing docs.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
build-system, documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 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.