featzhang opened a new pull request, #27771:
URL: https://github.com/apache/flink/pull/27771
## Purpose
This PR adds a Top N Metrics Dashboard to the Flink Web UI, providing
operators with enhanced visibility into resource-intensive components in their
Flink jobs. The dashboard displays three critical metric categories in
real-time:
1. **Top N CPU Consumers** - Tasks consuming the most CPU resources
2. **Top N Backpressure Operators** - Operators experiencing the highest
backpressure ratios
3. **Top N GC Intensive Tasks** - Tasks with the highest garbage collection
overhead
This feature enables faster identification of performance bottlenecks and
helps operators optimize job execution by quickly locating problematic
components.
## Change log
**Backend Changes:**
- Added `TopNMetricsHandler.java` - REST API handler for Top N metrics
aggregation
- Added `TopNMetricsHeaders.java` - REST endpoint definition and response
type specification
- Added `TopNMetricsMessageParameters.java` - Request parameter definitions
- Added `TopNMetricsResponseBody.java` - Response body structure with three
inner classes
**Frontend Changes:**
- Added `TopNMetricsService.ts` - Service to fetch Top N metrics from backend
- Added `topn-metrics.ts` - TypeScript interface definitions
- Added `TopNMetricsComponent` - Angular component with HTML template and
Less styles
- Added `OverviewDemoComponent` - Demo page showcasing the feature
**New REST API:**
- `GET /jobs/:jobid/metrics/top-n` - Returns Top N metrics for a specified
job
## Verifying
1. Build the Flink project: `mvn clean install -DskipTests`
2. Build the web dashboard: `cd flink-runtime-web/web-dashboard && npm
install && npm run build`
3. Start a local Flink cluster with a sample job
4. Access the demo page at `/overview-demo` to see the Top N Metrics
Dashboard
5. For integration testing, navigate to `/jobs/{jobId}/metrics/top-n` to
verify API returns valid data
## Impact
**Scope:**
- New feature addition to the Flink Web UI
- Does not modify existing API behavior
- Only adds a new REST endpoint and frontend components
**Performance:**
- Minimal overhead as metrics are already being collected and cached
- No impact on job execution performance
**Compatibility:**
- Fully backward compatible
- Optional feature
## Documentation
Documentation updates needed for:
- Web UI documentation
- REST API reference
- Monitoring and debugging guides
--
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]
