Repository navigation
fix(telemetry): warn once on uninitialized telemetry access and add explicit validation helpers - #877
Merged
Conversation
|
@Gezziy 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 #768
Summary of Changes
src/performance/telemetry.tsvia an internalwarnIfUninitialized()dispatcher andwarnedMethodsset. Direct telemetry getters (getTelemetryManager(),getTelemetryData(),getTelemetryMetricsSummary(),getTelemetrySpans()) now log an actionableconsole.warnupon their first uninitialized call of a session.validateTelemetryInitialized(): SorokitResult<void>— checks if telemetry is initialized and returnsINVALID_CONFIGif inactive.requireTelemetryManager(): SorokitResult<OpenTelemetryManager>— returns the active manager or an error result.requireTelemetryData(): SorokitResult<TelemetryData>— returns the active telemetry data or an error result.src/performance/index.tsandsrc/index.ts.initTelemetry(),resetTelemetry(), andshutdownTelemetry()automatically clear warning tracking state.src/performance/telemetry.test.tsverifying warn-once behavior, deduplication, suppression on initialization, reset semantics, and explicit validator branching (total 51 passing tests).Reason for the Changes
Fixes #768.
getTelemetryManager()andgetTelemetryData()previously returnednullifinitTelemetry()had not been invoked, leading to silent loss of observability metrics, error reporting, and distributed tracing. The warn-once approach alerts developers to missing initialization immediately without spamming logs or breaking existing code that depends onnullreturns.