You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
Repository navigation
[Website] Fix the diagnostic event tables on the instrumentation page - #10672
The event tables on the instrumentation page did not match the diagnostic listeners. This updates all three tables and the server listener sample:
Removes SyntaxError and the three operation complexity events, which the execution listener does not declare, and adds AnalyzeOperationCost, OperationCost, DocumentNotFoundInStorage, UntrustedDocumentRejected, WebSocketConnectionInitialized, and the four batch dispatch coordinator events.
Corrects when RequestError, StartProcessing, StopProcessing, RunTask, and ResolvedTaskFromCache are raised, notes that RunTask also requires EnableResolveFieldValue, and moves rows that were out of order in the request flow, keeping each error event next to its scope.
Fixes the server listener sample, whose ExecuteHttpRequest override did not match the method's signature.
StopProcessing is raised whenever WorkScheduler pauses its task loop, including while it is waiting for in-flight execution tasks or pending DataLoader dispatches, not only while waiting for resolvers. Please describe the event as pausing task processing while waiting for more work or in-flight tasks to complete so listeners do not infer that it exclusively represents resolver waits.
RunTask is not an alternative to ResolveFieldValue for field resolvers. ExecutionTask.ExecuteInternalAsync wraps every execution task in Context.Track(this), while ResolverTask.ExecuteAsync separately wraps the resolver in ResolveFieldValue; when EnableResolveFieldValue is enabled, a resolver therefore raises both events. Please describe ResolveFieldValue as an additional event rather than saying it is raised instead.
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
📚 documentationThis issue is about working on our documentation.
2 participants
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.
Summary
The event tables on the instrumentation page did not match the diagnostic listeners. This updates all three tables and the server listener sample:
SyntaxErrorand the three operation complexity events, which the execution listener does not declare, and addsAnalyzeOperationCost,OperationCost,DocumentNotFoundInStorage,UntrustedDocumentRejected,WebSocketConnectionInitialized, and the four batch dispatch coordinator events.RequestError,StartProcessing,StopProcessing,RunTask, andResolvedTaskFromCacheare raised, notes thatRunTaskalso requiresEnableResolveFieldValue, and moves rows that were out of order in the request flow, keeping each error event next to its scope.ExecuteHttpRequestoverride did not match the method's signature.