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

.NET 8–Keyed/Named Services

A feature that a lot of IoC container libraries support but that was missing in the default DI container provided by Microsoft is the support for Keyed or Named Services. This feature allows you to register the same type multiple times using different names, allowing you to resolve a specific instance based on the circumstances. Although there is some controversy if supporting this feature is a good idea or not, it certainly can be handy. To support this feature a new interface IKeyedServiceProvider got introduced in .NET 8 providing 2 new methods on our ServiceProvider instance: object? GetKeyedService(Type serviceType, object? serviceKey); object GetRequiredKeyedService(Type serviceType, object? serviceKey); To use it, we need to register our service using one of the new extension methods: Resolving the service can be done either through the FromKeyedServices attribute: or by injecting the IKeyedServiceProvider interface and calling the GetRequiredKeyedServic...
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

Kubernetes–Limit your environmental impact

Reducing the carbon footprint and CO2 emission of our (cloud) workloads, is a responsibility of all of us. If you are running a Kubernetes cluster, have a look at Kube-Green . kube-green is a simple Kubernetes operator that automatically shuts down (some of) your pods when you don't need them. A single pod produces about 11 Kg CO2eq per year( here the calculation). Reason enough to give it a try! Installing kube-green in your cluster The easiest way to install the operator in your cluster is through kubectl. We first need to install a cert-manager: kubectl apply -f https://github.com/cert-manager/cert-manager/releases/download/v1.14.5/cert-manager.yaml Remark: Wait a minute before you continue as it can take some time before the cert-manager is up & running inside your cluster. Now we can install the kube-green operator: kubectl apply -f https://github.com/kube-green/kube-green/releases/latest/download/kube-green.yaml Now in the namespace where we want t...
Read more