Repository navigation
add a custom event record that new relic can pick up instead of logging - #3386
Merged
Merged
Conversation
Contributor
There was a problem hiding this comment.
🟢 Approval recommended
The additive telemetry preserves existing logging, enablement controls, and failure isolation, with no blocking issues identified.
No open issues 🎉
What changed in this PR
Adds New Relic custom events for backend performance diagnostics, allowing metrics to be queried alongside transaction data while retaining existing JSON logging and enablement controls.
Changes:
- Emits
PerfDiagwindow reports andPerfDiagCacheWriteslow-write events. - Flattens nested event attributes and omits null values through a failure-isolated New Relic wrapper.
- Adds tests for event payloads, missing fields, and slow-write thresholds.
| File | Description |
|---|---|
packages/backend/test/unit/lib/perfDiagnostics.test.ts |
Tests event emission, flattened attributes, and threshold behavior. |
packages/backend/src/lib/perfDiagnostics.ts |
Emits custom events alongside existing diagnostic logs. |
packages/backend/src/lib/newrelic.ts |
Adds a guarded custom-event API wrapper. |
packages/backend/src/env.ts |
Removes “Temporary” from the diagnostics comment; no behavior change. |
packages/backend/src/api/services/CacheService.ts |
Clarifies the cache-write instrumentation comment; no behavior change. |
Review effort: Balanced
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.
adds "perfdiag" stats events as a custom event that can be piped directly to new relic instead of using logging.
https://docs.newrelic.com/docs/data-apis/custom-data/custom-events/report-custom-event-data/
this will allow us to query it all in NR, and obviate the need for the app that I created to marry the splunk logs with new relic data.
i'm leaving the logging for now, but that could be removed later if this works.