feat(listener): delivery metrics endpoint — closes #482 - #538
Open
kitWarse wants to merge 1 commit into
Open
Conversation
…y#482 ## What changed ### listener/src/api/events-server.ts - Added GET /api/metrics/delivery route (inserted after GET /api/analytics) - Reuses the existing NotificationAnalyticsAggregator (options.analyticsAggregator or the process-wide default) — zero new dependencies or allocations - Accepts optional ?window=1h|6h|24h|7d query parameter to restrict the report to a recent time slice; returns 400 for unrecognised values - Response shape: meta { generatedAt, windowStart, windowEnd, windowParam, totalRecorded } delivery { total, success, failure, retry, skipped, successRate, averageDurationMs } byType [ { notificationType, total, success, failure, successRate } ] errorBreakdown { reason: count, ... } hourlyBuckets [ { bucketStart, total, success, failure, retry, skipped, avgDuration } ] - Fully logged via existing logger (requestId, correlationId, window, total, durationMs) - Read-only — never resets the aggregator ### docs/api/metrics-delivery.md [NEW] - Full API reference: method, path, query parameters, request/response schema, error table, notes on auth, rate-limiting, performance, and related endpoints Closes Core-Foundry#482
|
@kitWarse Great news! 🎉 Based on an automated assessment of this PR, the linked Wave issue(s) no longer count against your application limits. You can now already apply to more issues while waiting for a review of this PR. Keep up the great work! 🚀 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #482
Summary
Implements issue #482 — Expose delivery statistics through an API endpoint for monitoring notification performance.
Changes
listener/src/api/events-server.ts
New route GET /api/metrics/delivery inserted after the existing GET /api/analytics block.
jsonc { meta: { generatedAt, windowStart, windowEnd, windowParam, totalRecorded }, delivery: { total, success, failure, retry, skipped, successRate, averageDurationMs }, byType: [ { notificationType, total, success, failure, successRate } ], errorBreakdown: { reason: count }, hourlyBuckets: [ { bucketStart, total, success, failure, retry, skipped, averageDurationMs } ] }equestId, correlationId, window, otal, durationMs).
docs/api/metrics-delivery.md (new)
Complete API reference covering:
Acceptance Criteria