Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reworked Open-Telemetry Defaults #4612

Merged
merged 1 commit into from
Jan 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 28 additions & 16 deletions src/HotChocolate/Diagnostics/src/Diagnostics/ActivityScopes.cs
Original file line number Diff line number Diff line change
Expand Up @@ -6,20 +6,32 @@ namespace HotChocolate.Diagnostics;
public enum ActivityScopes
{
None = 0,
ParseRequest = 1,
ParseDocument = 2,
ValidateDocument = 4,
AnalyzeComplexity = 8,
CoerceVariables = 16,
CompileOperation = 32,
ExecuteOperation = 64,
ResolveFieldValue = 128,
All = ParseRequest |
ParseDocument |
ValidateDocument |
AnalyzeComplexity |
CoerceVariables |
CompileOperation |
ExecuteOperation |
ResolveFieldValue
ExecuteHttpRequest= 1,
ParseHttpRequest = 2,
FormatHttpResponse = 4,
ExecuteRequest = 8,
ParseDocument = 16,
ValidateDocument = 32,
AnalyzeComplexity = 64,
CoerceVariables = 128,
CompileOperation = 256,
ExecuteOperation = 512,
ResolveFieldValue = 1024,
Default =
ExecuteHttpRequest |
ParseHttpRequest |
ResolveFieldValue |
FormatHttpResponse,
All =
ExecuteHttpRequest |
ParseHttpRequest |
FormatHttpResponse |
ExecuteRequest |
ParseDocument |
ValidateDocument |
AnalyzeComplexity |
CoerceVariables |
CompileOperation |
ExecuteOperation |
ResolveFieldValue
}
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ public sealed class InstrumentationOptions
/// <summary>
/// Specifies the activity scopes that shall be instrumented.
/// </summary>
public ActivityScopes Scopes { get; set; }
public ActivityScopes Scopes { get; set; } = ActivityScopes.Default;

/// <summary>
/// Specifies if the parsed document shall be included into the tracing data.
Expand All @@ -24,7 +24,13 @@ public sealed class InstrumentationOptions

internal bool IncludeRequestDetails => RequestDetails is not RequestDetails.None;

internal bool SkipParseRequest => (Scopes & ParseRequest) != ParseRequest;
internal bool SkipExecuteHttpRequest => (Scopes & ExecuteHttpRequest) != ExecuteHttpRequest;

internal bool SkipParseHttpRequest => (Scopes & ParseHttpRequest) != ParseHttpRequest;

internal bool SkipFormatHttpResponse => (Scopes & FormatHttpResponse) != FormatHttpResponse;

internal bool SkipExecuteRequest => (Scopes & ExecuteRequest) != ExecuteRequest;

internal bool SkipParseDocument => (Scopes & ParseDocument) != ParseDocument;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
using HotChocolate.Execution;
using HotChocolate.Execution.Instrumentation;
using HotChocolate.Resolvers;
using Microsoft.AspNetCore.Http;
using OpenTelemetry.Trace;
using static HotChocolate.Diagnostics.ContextKeys;
using static HotChocolate.Diagnostics.HotChocolateActivitySource;
Expand All @@ -26,7 +27,25 @@ public ActivityExecutionDiagnosticListener(

public override IDisposable ExecuteRequest(IRequestContext context)
{
Activity? activity = Source.StartActivity();
Activity? activity = null;

if (_options.SkipExecuteRequest)
{
if (!_options.SkipExecuteHttpRequest &&
context.ContextData.TryGetValue(nameof(HttpContext), out var value) &&
value is HttpContext httpContext &&
httpContext.Items.TryGetValue(HttpRequestActivity, out value) &&
value is not null)
{
activity = (Activity)value;
}
else
{
return EmptyScope;
}
}

activity ??= Source.StartActivity();

if (activity is null)
{
Expand Down Expand Up @@ -186,7 +205,7 @@ public override void OperationComplexityResult(
activity.SetTag("graphql.document.complexity", complexity);
activity.SetTag("graphql.executor.allowedComplexity", allowedComplexity);

if(complexity <= allowedComplexity)
if (complexity <= allowedComplexity)
{
activity.SetStatus(Status.Ok);
activity.SetStatus(ActivityStatusCode.Ok);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,11 @@ public ActivityServerDiagnosticListener(

public override IDisposable ExecuteHttpRequest(HttpContext context, HttpRequestKind kind)
{
if (_options.SkipExecuteHttpRequest)
{
return EmptyScope;
}

Activity? activity = HotChocolateActivitySource.Source.StartActivity();

if (activity is null)
Expand Down Expand Up @@ -94,7 +99,7 @@ public override void HttpRequestError(HttpContext context, Exception exception)

public override IDisposable ParseHttpRequest(HttpContext context)
{
if (_options.SkipParseRequest)
if (_options.SkipParseHttpRequest)
{
return EmptyScope;
}
Expand Down Expand Up @@ -129,6 +134,11 @@ public override void ParserErrors(HttpContext context, IReadOnlyList<IError> err

public override IDisposable FormatHttpResponse(HttpContext context, IQueryResult result)
{
if (_options.SkipFormatHttpResponse)
{
return EmptyScope;
}

Activity? activity = HotChocolateActivitySource.Source.StartActivity();

if (activity is null)
Expand Down
Original file line number Diff line number Diff line change
@@ -1,33 +1,40 @@
{
"activities": [
{
"OperationName": "ExecuteRequest",
"DisplayName": "Execute Request",
"Status": "Unset",
"OperationName": "ResolveFieldValue",
"DisplayName": "/sayHello",
"Status": "Ok",
"tags": [
{
"Key": "graphql.document.id",
"Value": "9+mYn7tnr3+nR6mYMxPJ5Q=="
"Key": "graphql.selection.name",
"Value": "sayHello"
},
{
"Key": "graphql.document.hash",
"Value": "9+mYn7tnr3+nR6mYMxPJ5Q=="
"Key": "graphql.selection.parentType",
"Value": "SimpleQuery"
},
{
"Key": "graphql.operation.id",
"Value": "9+mYn7tnr3+nR6mYMxPJ5Q=="
}
],
"event": [
"Key": "graphql.selection.coordinate",
"Value": "SimpleQuery.sayHello"
},
{
"Key": "graphql.selection.type",
"Value": "String!"
},
{
"Key": "graphql.selection.path",
"Value": "/sayHello"
},
{
"Name": "AddedOperationToCache",
"Tags": {}
"Key": "graphql.selection.hierarchy",
"Value": "/sayHello"
},
{
"Name": "AddedDocumentToCache",
"Tags": {}
"Key": "otel.status_code",
"Value": "OK"
}
]
],
"event": []
}
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"activities": [
{
"OperationName": "ExecuteHttpRequest",
"DisplayName": "GraphQL HTTP POST",
"DisplayName": "Execute Request",
"Status": "Unset",
"tags": [
{
Expand All @@ -20,34 +20,69 @@
{
"Key": "graphql.http.request.query.hash",
"Value": "pXCmv/dItZFurfFTJh2cbQ=="
},
{
"Key": "graphql.document.id",
"Value": "pXCmv/dItZFurfFTJh2cbQ=="
},
{
"Key": "graphql.operation.id",
"Value": "pXCmv/dItZFurfFTJh2cbQ=="
}
],
"event": [
{
"Name": "AddedOperationToCache",
"Tags": {}
},
{
"Name": "AddedDocumentToCache",
"Tags": {}
}
],
"event": [],
"activities": [
{
"OperationName": "ExecuteRequest",
"DisplayName": "Execute Request",
"OperationName": "ParseHttpRequest",
"DisplayName": "Parse HTTP Request",
"Status": "Unset",
"tags": [],
"event": []
},
{
"OperationName": "ResolveFieldValue",
"DisplayName": "/hero",
"Status": "Ok",
"tags": [
{
"Key": "graphql.document.id",
"Value": "pXCmv/dItZFurfFTJh2cbQ=="
"Key": "graphql.selection.name",
"Value": "hero"
},
{
"Key": "graphql.operation.id",
"Value": "pXCmv/dItZFurfFTJh2cbQ=="
}
],
"event": [
"Key": "graphql.selection.parentType",
"Value": "Query"
},
{
"Key": "graphql.selection.coordinate",
"Value": "Query.hero"
},
{
"Name": "AddedOperationToCache",
"Tags": {}
"Key": "graphql.selection.type",
"Value": "Character"
},
{
"Name": "AddedDocumentToCache",
"Tags": {}
"Key": "graphql.selection.path",
"Value": "/hero"
},
{
"Key": "graphql.selection.hierarchy",
"Value": "/hero"
},
{
"Key": "otel.status_code",
"Value": "OK"
}
]
],
"event": []
},
{
"OperationName": "FormatHttpResponse",
Expand Down