feat: add memory accounting middleware to track and alert on request …#568
Open
oyinade247 wants to merge 1 commit into
Open
feat: add memory accounting middleware to track and alert on request …#568oyinade247 wants to merge 1 commit into
oyinade247 wants to merge 1 commit into
Conversation
|
@oyinade247 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
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 #483
Description
Adds per-request heap delta tracking middleware for the GrantFox campaign. Samples
process.memoryUsage().heapUsedat request start and end, logs a structured warning when the delta exceeds a configurable threshold.Changes
New Files
src/middleware/memoryAccounting.ts— Factory functioncreateMemoryAccountingMiddlewarethat returns an Express middleware. Whenenabled=false(default) it is a complete no-op — zero overhead, no heap sampling, no listener registration. When enabled, it captures heap at request start, hooksres.on('finish'), computes the delta, and emits a structuredlogger.warnvia Pino if the delta exceedsthresholdMb.src/middleware/memoryAccounting.test.ts— 11 unit tests covering disabled mode, threshold breaches, within-threshold behaviour, zero/negative deltas, request-id fallback, and zero-threshold edge case.Modified Files
src/config/env.ts— Added two env vars:MEMORY_ACCOUNTING_ENABLED(string→boolean, defaultfalse)MEMORY_ACCOUNTING_THRESHOLD_MB(number, nonnegative, default50)src/config/index.ts— ExposesmemoryAccounting.enabledandmemoryAccounting.thresholdMbon the config object.src/app.ts— Mounts the middleware afterrequestIdMiddlewareand beforemetricsMiddleware.Acceptance Criteria
finisheventdeltaBytes > thresholdBytes(_req, _res, next) => next()— no heap calls, no listenersSecurity
nonnegative, coerced number)Testing
Usage