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

DevToys–A swiss army knife for developers

As a developer there are a lot of small tasks you need to do as part of your coding, debugging and testing activities.  DevToys is an offline windows app that tries to help you with these tasks. Instead of using different websites you get a fully offline experience offering help for a large list of tasks. Many tools are available. Here is the current list: Converters JSON <> YAML Timestamp Number Base Cron Parser Encoders / Decoders HTML URL Base64 Text & Image GZip JWT Decoder Formatters JSON SQL XML Generators Hash (MD5, SHA1, SHA256, SHA512) UUID 1 and 4 Lorem Ipsum Checksum Text Escape / Unescape Inspector & Case Converter Regex Tester Text Comparer XML Validator Markdown Preview Graphic Color B
Read more

Help! I accidently enabled HSTS–on localhost

I ran into an issue after accidently enabling HSTS for a website on localhost. This was not an issue for the original website that was running in IIS and had a certificate configured. But when I tried to run an Angular app a little bit later on http://localhost:4200 the browser redirected me immediately to https://localhost . Whoops! That was not what I wanted in this case. To fix it, you need to go the network settings of your browser, there are available at: chrome://net-internals/#hsts edge://net-internals/#hsts brave://net-internals/#hsts Enter ‘localhost’ in the domain textbox under the Delete domain security policies section and hit Delete . That should do the trick…
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