Skip to content

[Website] Fix the diagnostic event tables on the instrumentation page - #10672

Merged
glen-84 merged 3 commits into
mainfrom
gai/instrumentation-event-tables
Oct 23, 2026
Merged

glen-84 merged 3 commits into
mainfrom
gai/instrumentation-event-tables

Conversation

@glen-84

@glen-84 glen-84 commented Oct 23, 2026 •

Copy link
Copy Markdown
Member

Summary

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.

Copilot AI lite review requested due to automatic review settings October 23, 2026 09:16
@github-actions github-actions Bot added the 📚 documentation This issue is about working on our documentation. label Oct 23, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟡 Changes recommended

Unresolved documentation corrections remain for event ordering and lifecycle descriptions.

1 open issue
What changed in this PR

Updates the instrumentation documentation to align diagnostic event tables and the server listener sample with current Hot Chocolate behavior.

Changes:

  • Adds current diagnostic events and removes obsolete ones.
  • Corrects event descriptions, lifecycle ordering, and configuration notes.
  • Fixes the ExecuteHttpRequest override signature and documents batch coordinator events.
File Description
website/​content/​docs/​hotchocolate/​server/​instrumentation.md Updates server, execution, and DataLoader event tables and corrects the server listener example.

Review effort: Lite

Comment thread website/content/docs/hotchocolate/server/instrumentation.md Outdated

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The reviewed event descriptions and ordering contain unresolved accuracy issues that should be corrected before approval.

No open issues 🎉

1 previously missed issue

In code that hasn't changed since last review

Low severity Clarify StopProcessing covers all task-processing pauses

website/​content/​docs/​hotchocolate/​server/​instrumentation.md:160

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.

1 resolved since last review

Review effort: Lite

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🔵 Needs a closer look

The reviewed documentation still has three event-ordering and event-behavior descriptions that need correction.

No open issues 🎉

1 previously missed issue

In code that hasn't changed since last review

Low severity Describe ResolveFieldValue as an additional resolver event

website/​content/​docs/​hotchocolate/​server/​instrumentation.md:161

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.

Review effort: Lite

@glen-84
glen-84 merged commit 57083fa into main Oct 23, 2026
22 checks passed
@glen-84
glen-84 deleted the gai/instrumentation-event-tables branch October 23, 2026 10:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📚 documentation This issue is about working on our documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants