featzhang commented on PR #27774:
URL: https://github.com/apache/flink/pull/27774#issuecomment-4358842683
Force-pushed a cleaned-up version of this PR. Summary of changes:
**1. Fixed CI failure
(`RuntimeOpenRestAPIDocsCompletenessITCase.testRuntimeRestApiDocsUpToDate`)**
The previous CI run (Azure build #74503) was failing because the
newly-introduced `TopNMetricsHandler` was registered in `WebMonitorEndpoint`,
but the committed REST API docs were stale. I regenerated them locally with:
```
./mvnw package -Dgenerate-rest-docs -pl flink-docs -am -nsu -DskipTests
-Pskip-webui-build
```
Both `docs/layouts/shortcodes/generated/rest_v1_dispatcher.html` (+113
lines) and `docs/static/generated/rest_v1_dispatcher.yml` (+74 lines) are now
updated. The new entries are exclusively related to
`/jobs/{jobid}/metrics/top-n` and its `TopNMetricsResponseBody` schema
(`BackpressureOperatorInfo`, `CpuConsumerInfo`, `GcTaskInfo`). I verified
locally that `RuntimeOpenRestAPIDocsCompletenessITCase` now passes.
**2. Fixed commit message JIRA ID (thanks @spuru9 for catching this)**
Squashed the previous 3 commits into a single feature commit and corrected
the JIRA ID from `FLINK-27773` to `FLINK-39489`, which is the ticket actually
tracking this feature. The regenerated docs are in a separate follow-up commit
for clarity.
**3. Rebased onto latest master**
Branch is now up-to-date with `apache/flink@master` and `mergeStateStatus`
is `CLEAN`.
Final commit history on this PR:
- `[FLINK-39489][Web Dashboard] Add Top N Metrics Dashboard`
- `[FLINK-39489][docs] Regenerate REST API docs for new Top N Metrics
endpoint`
Ready for another CI run & review. cc @spuru9
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
