lifecycle hooks at ingestion, query, alert evaluation and webhook dispatch (#216) - #241
Merged
Conversation
Codecov Report❌ Patch coverage is 📢 Thoughts on this report? Let us know! |
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.
Refs #216.
What
A small, typed set of four named lifecycle hooks, no-op by default in OSS:
beforeIngestrecordsbeforeQueryqueryLogs, before the cache keyparamsbeforeAlertEvaluationbeforeWebhookDispatchsafeFetch(channel + legacy alert paths)Handlers run sequentially in registration order, may mutate the documented fields, and abort by throwing
HookRejectionError(code, message, statusCode)which the global error handler surfaces like capability errors. Unexpected hook errors fail closed (500, chained viaError.cause), except in the alert loop where a failing hook skips only that rule and the batch continues.Registration
hooks.register(...)fromsrc/hooks/index.jsin a downstream bootstrap.HOOKS_MODULESenv (comma-separated module paths default-exporting(hooks, helpers) => void), loaded at boot on server and worker, fatal on load failure. External modules receive{ HookRejectionError }as the second arg so they can produce clean 4xx rejections.Notes
beforeIngestrealigns downstream consumers (sigma, exceptions, pipelines, metering, correlation) when a hook filters records; a tenancy guard fails closed if a hook rewrites a record'sprojectId.docs/lifecycle-hooks.md.Tests
56 new hook tests (registry, loader, all four call sites, HTTP-stack rejection). Full backend suite green except the pre-existing env-only
digests/generatornumber-locale failures on Windows.