Skip to main content

HotChocolate OpenTelemetry

HotChocolate remains my favorite GraphQL client for .NET. As I find it really important to monitor my applications, I have written multiple posts(hereand here) on how to integrate monitoring with HotChocolate.

At the beginning of this year, with the release of HotChocolate 12.5, support for OpenTelemetry was introduced. Although I updated my applications to start using it, it took me until now to write a corresponding blog post about it.

Instrument your GraphQL Server with OpenTelemetry

Let me walk you through the steps:

  • We’ll start with an ASP.NET Core application with OpenTelemetry enabled. Therefore we added the following NuGet packages:
    • OpenTelemetry.Extensions.Hosting
    • OpenTelemetry.Instrumentation.AspNetCore
    • OpenTelemetry.Instrumentation.Http
    • OpenTelemetry.Instrumentation.SqlClient
  • We also add a reference to the AzureMonitor exporter because we want to use Application Insights:
    • Azure.Monitor.OpenTelemetry.Exporter
  • Of course we need to add some code to enable OpenTelemetry:
  •   Everything we need to use OpenTelemetry with HotChocolate can be found in the following NuGet package:
    • HotChocolate.Diagnostics
  • After you have installed this package, we can extend the OpenTelemetry configuration:
  • Almost there! As a last step, we need to update our GraphQL Server configuration:
  • Let me explain the settings I’m using a little bit more:
    • Scopes: Allows you to specify which subscopes should be included in the trace data. I’ve set this to ‘ActivityScopes.All’ in this example but know that you can control this. Be aware that adding extra scopes has a performance impact. 
    • RenameRootActivity: By setting this to ‘true’ the the Operation display name will be shown as part of the root activity.
    • IncludeDocument: By setting this to ‘true’ the parsed document will be included in the trace data.

If we now have a look at how this arrives in Application Insights, you see that you get full traceability:

And if you look at a specific trace message, you get all the details:

More information: https://chillicream.com/docs/hotchocolate/server/instrumentation#opentelemetry

Labels:

Popular posts from this blog

Podman– Command execution failed with exit code 125

After updating WSL on one of the developer machines, Podman failed to work. When we took a look through Podman Desktop, we noticed that Podman had stopped running and returned the following error message: Error: Command execution failed with exit code 125 Here are the steps we tried to fix the issue: We started by running podman info to get some extra details on what could be wrong: >podman info OS: windows/amd64 provider: wsl version: 5.3.1 Cannot connect to Podman. Please verify your connection to the Linux system using `podman system connection list`, or try `podman machine init` and `podman machine start` to manage a new Linux VM Error: unable to connect to Podman socket: failed to connect: dial tcp 127.0.0.1:2655: connectex: No connection could be made because the target machine actively refused it. That makes sense as the podman VM was not running. Let’s check the VM: >podman machine list NAME         ...
Read more

Azure DevOps/ GitHub emoji

I’m really bad at remembering emoji’s. So here is cheat sheet with all emoji’s that can be used in tools that support the github emoji markdown markup: All credits go to rcaviers who created this list.
Read more

VS Code Planning mode

After the introduction of Plan mode in Visual Studio , it now also found its way into VS Code. Planning mode, or as I like to call it 'Hannibal mode', extends GitHub Copilot's Agent Mode capabilities to handle larger, multi-step coding tasks with a structured approach. Instead of jumping straight into code generation, Planning mode creates a detailed execution plan. If you want more details, have a look at my previous post . Putting plan mode into action VS Code takes a different approach compared to Visual Studio when using plan mode. Instead of a configuration setting that you can activate but have limited control over, planning is available as a separate chat mode/agent: I like this approach better than how Visual Studio does it as you have explicit control when plan mode is activated. Instead of immediately diving into execution, the plan agent creates a plan and asks some follow up questions: You can further edit the plan by clicking on ‘Open in Editor’: ...
Read more