RenameRootActivity not working anymore

[glucaci]

Product

Hot Chocolate

Version

13.7.0

Link to minimal reproduction

open-telemetry/opentelemetry-dotnet#5026

Steps to reproduce

builder.AddInstrumentation(o =>
{
    o.RenameRootActivity = true;
});

What is expected?

The root Activity to include the graphql operation

What is actually happening?

The root Activity contains only the default AspNetCore DisplayName

Relevant log output

No response

Additional context

This happens since OpenTelemetry.Instrumentation.AspNetCore 1.6.0-beta.3 because of this change open-telemetry/opentelemetry-dotnet#5026

[michaelstaib]

@glucaci but it looks like that they do not allow the rename anymore

[monco83]

We are intrested in this bug. Any news coming?

[glucaci]

@michaelstaib yes, there is no flexibility to rename it anymore.

I would in HotChocolate mark the RenameRootActivity as obsolate because there is no way to do it anymore and instead of directly renaming the Activity I would add the operation name as tag to the activity. Afterwords the user can rename it with the Enrich support from OpenTelemetry.Instrumentation.AspNetCore package.

For the current version what we did as workaround is:

1. Create a custom ActivityEnricher which add the operation name to the activity. (this we would not need it if HotChocolate will attach this information on the Activity)

public sealed class GraphQLActivityEnricher : ActivityEnricher
{
    public GraphQLActivityEnricher(
        ObjectPool<StringBuilder> stringBuilderPool,
        InstrumentationOptions options)
        : base(stringBuilderPool, options)
    {
    }

    protected override string CreateRootActivityName(
        Activity activity,
        Activity root,
        string operationDisplayName)
    {
        activity.SetCustomProperty("graphqlDisplayName", operationDisplayName);
        root.SetCustomProperty("graphqlDisplayName", operationDisplayName);

        return operationDisplayName;
    }
}

2. Register the activity enricher

services.AddSingleton<ActivityEnricher, GraphQLActivityEnricher>();

3. In the OpenTelemetry registration configure the Enricher

openTelemetryBuilder.WithTracing(tracer => tracer.AddAspNetCoreInstrumentation(o =>
{
    o.EnrichWithHttpResponse = (activity, _) =>
    {
        var rawDisplayName = activity.GetCustomProperty("graphqlDisplayName");
        if (rawDisplayName is string graphqlDisplayName &&
            !string.IsNullOrEmpty(graphqlDisplayName))
        {
            activity.DisplayName = graphqlDisplayName;
        }
    };
}));

[monco83]

Thank you, it's clear.

[PascalSenn]

@michaelstaib @monco83 @glucaci

I opened a pr on the otel repo:
open-telemetry/opentelemetry-dotnet#5402 (comment)

[huysentruitw]

I was trying this work-around on Azure Application Insights and it took me somewhile to realize Application Insights doesn't show the trace DisplayName if the tags http.route and url.path are set. Instead, it shows the HTTP-method followed by http.route (with fallback to url.path). So to get the graphql operation visible, I also had to manipulate the http.route-tag on the activity.

[michaelstaib]

@huysentruitw in 14 you can use the new semantic routes in Hot Chocolate.

[michaelstaib]

Hey,

I have tested this on main.

What I tested:

• Retested at commit 38911022f4.

public class Issue6862ProbeTests
{
    [Fact]
    public async Task RenameRootActivity_Updates_Existing_Root_Activity_Name()
    {
        var listener = new ActivityListener
        {
            ShouldListenTo = source => source.Name == "HotChocolate.Diagnostics",
            Sample = (ref ActivityCreationOptions<ActivityContext> _) =>
                ActivitySamplingResult.AllDataAndRecorded
        };
        ActivitySource.AddActivityListener(listener);

        using var session = listener;
        using var root = new Activity("Microsoft.AspNetCore.Hosting.HttpRequestIn");
        root.DisplayName = "HTTP POST /graphql";
        root.Start();

        await new ServiceCollection()
            .AddGraphQL()
            .AddInstrumentation(o =>
            {
                o.RenameRootActivity = true;
                o.Scopes = ActivityScopes.All;
            })
            .AddQueryType<Query>()
            .ExecuteRequestAsync("{ sayHello }");

        Assert.Equal("HTTP POST /graphql: query { sayHello }", root.DisplayName);
    }

    public sealed class Query
    {
        public string SayHello() => "Hello";
    }
}

This passes on net8/net9/net10 on current main, and the root activity gets renamed with the GraphQL operation name.

So I could not reproduce this on current main and I’m closing it.