Table of Contents

Class ActivityEnricher

Namespace
HotChocolate.Diagnostics
Assembly
HotChocolate.Diagnostics.dll

The activity enricher is used to add information to the activity spans. You can inherit from this class and override the enricher methods to provide more or less information.

public class ActivityEnricher
Inheritance
ActivityEnricher
Inherited Members

Constructors

ActivityEnricher(ObjectPool<StringBuilder>, InstrumentationOptions)

Initializes a new instance of ActivityEnricher.

protected ActivityEnricher(ObjectPool<StringBuilder> stringBuilderPoolPool, InstrumentationOptions options)

Parameters

stringBuilderPoolPool ObjectPool<StringBuilder>
options InstrumentationOptions

Properties

StringBuilderPool

Gets the StringBuilder pool used by this enricher.

protected ObjectPool<StringBuilder> StringBuilderPool { get; }

Property Value

ObjectPool<StringBuilder>

Methods

CreateOperationDisplayName(IRequestContext) 

protected virtual string? CreateOperationDisplayName(IRequestContext context)

Parameters

context IRequestContext

Returns

string

CreateRootActivityName(Activity, Activity, string) 

protected virtual string CreateRootActivityName(Activity activity, Activity root, string displayName)

Parameters

activity Activity
root Activity
displayName string

Returns

string

EnrichAnalyzeOperationComplexity(IRequestContext, Activity) 

public virtual void EnrichAnalyzeOperationComplexity(IRequestContext context, Activity activity)

Parameters

context IRequestContext
activity Activity

EnrichBatchExtensions(HttpContext, GraphQLRequest, IReadOnlyDictionary<string, object?>, int, Activity) 

protected virtual void EnrichBatchExtensions(HttpContext context, GraphQLRequest request, IReadOnlyDictionary<string, object?> extensions, int index, Activity activity)

Parameters

context HttpContext
request GraphQLRequest
extensions IReadOnlyDictionary<string, object>
index int
activity Activity

EnrichBatchRequest(HttpContext, IReadOnlyList<GraphQLRequest>, Activity) 

public virtual void EnrichBatchRequest(HttpContext context, IReadOnlyList<GraphQLRequest> batch, Activity activity)

Parameters

context HttpContext
batch IReadOnlyList<GraphQLRequest>
activity Activity

EnrichBatchVariables(HttpContext, GraphQLRequest, ObjectValueNode, int, Activity) 

protected virtual void EnrichBatchVariables(HttpContext context, GraphQLRequest request, ObjectValueNode variables, int index, Activity activity)

Parameters

context HttpContext
request GraphQLRequest
variables ObjectValueNode
index int
activity Activity

EnrichCoerceVariables(IRequestContext, Activity) 

public virtual void EnrichCoerceVariables(IRequestContext context, Activity activity)

Parameters

context IRequestContext
activity Activity

EnrichCompileOperation(IRequestContext, Activity) 

public virtual void EnrichCompileOperation(IRequestContext context, Activity activity)

Parameters

context IRequestContext
activity Activity

EnrichDataLoaderBatch<TKey>(IDataLoader, IReadOnlyList<TKey>, Activity) 

public virtual void EnrichDataLoaderBatch<TKey>(IDataLoader dataLoader, IReadOnlyList<TKey> keys, Activity activity) where TKey : notnull

Parameters

dataLoader IDataLoader
keys IReadOnlyList<TKey>
activity Activity

Type Parameters

TKey

EnrichError(IError, Activity) 

protected virtual void EnrichError(IError error, Activity activity)

Parameters

error IError
activity Activity

EnrichExecuteHttpRequest(HttpContext, HttpRequestKind, Activity) 

public virtual void EnrichExecuteHttpRequest(HttpContext context, HttpRequestKind kind, Activity activity)

Parameters

context HttpContext
kind HttpRequestKind
activity Activity

EnrichExecuteOperation(IRequestContext, Activity) 

public virtual void EnrichExecuteOperation(IRequestContext context, Activity activity)

Parameters

context IRequestContext
activity Activity

EnrichExecuteRequest(IRequestContext, Activity) 

public virtual void EnrichExecuteRequest(IRequestContext context, Activity activity)

Parameters

context IRequestContext
activity Activity

EnrichFromatHttpResponse(HttpContext, Activity) 

public virtual void EnrichFromatHttpResponse(HttpContext context, Activity activity)

Parameters

context HttpContext
activity Activity

EnrichHttpRequestError(HttpContext, IError, Activity) 

public virtual void EnrichHttpRequestError(HttpContext context, IError error, Activity activity)

Parameters

context HttpContext
error IError
activity Activity

EnrichHttpRequestError(HttpContext, Exception, Activity) 

public virtual void EnrichHttpRequestError(HttpContext context, Exception exception, Activity activity)

Parameters

context HttpContext
exception Exception
activity Activity

EnrichOperationBatchRequest(HttpContext, GraphQLRequest, IReadOnlyList<string>, Activity) 

public virtual void EnrichOperationBatchRequest(HttpContext context, GraphQLRequest request, IReadOnlyList<string> operations, Activity activity)

Parameters

context HttpContext
request GraphQLRequest
operations IReadOnlyList<string>
activity Activity

EnrichParseDocument(IRequestContext, Activity) 

public virtual void EnrichParseDocument(IRequestContext context, Activity activity)

Parameters

context IRequestContext
activity Activity

EnrichParseHttpRequest(HttpContext, Activity) 

public virtual void EnrichParseHttpRequest(HttpContext context, Activity activity)

Parameters

context HttpContext
activity Activity

EnrichParserErrors(HttpContext, IError, Activity) 

public virtual void EnrichParserErrors(HttpContext context, IError error, Activity activity)

Parameters

context HttpContext
error IError
activity Activity

EnrichRequestExtensions(HttpContext, GraphQLRequest, IReadOnlyDictionary<string, object?>, Activity) 

protected virtual void EnrichRequestExtensions(HttpContext context, GraphQLRequest request, IReadOnlyDictionary<string, object?> extensions, Activity activity)

Parameters

context HttpContext
request GraphQLRequest
extensions IReadOnlyDictionary<string, object>
activity Activity

EnrichRequestVariables(HttpContext, GraphQLRequest, ObjectValueNode, Activity) 

protected virtual void EnrichRequestVariables(HttpContext context, GraphQLRequest request, ObjectValueNode variables, Activity activity)

Parameters

context HttpContext
request GraphQLRequest
variables ObjectValueNode
activity Activity

EnrichResolveFieldValue(IMiddlewareContext, Activity) 

public virtual void EnrichResolveFieldValue(IMiddlewareContext context, Activity activity)

Parameters

context IMiddlewareContext
activity Activity

EnrichResolverError(IRequestContext, ISelection, IError, Activity) 

public virtual void EnrichResolverError(IRequestContext context, ISelection selection, IError error, Activity activity)

Parameters

context IRequestContext
selection ISelection
error IError
activity Activity

EnrichResolverError(IMiddlewareContext, IError, Activity) 

public virtual void EnrichResolverError(IMiddlewareContext context, IError error, Activity activity)

Parameters

context IMiddlewareContext
error IError
activity Activity

EnrichSingleRequest(HttpContext, GraphQLRequest, Activity) 

public virtual void EnrichSingleRequest(HttpContext context, GraphQLRequest request, Activity activity)

Parameters

context HttpContext
request GraphQLRequest
activity Activity

EnrichSyntaxError(IRequestContext, Activity, IError) 

public virtual void EnrichSyntaxError(IRequestContext context, Activity activity, IError error)

Parameters

context IRequestContext
activity Activity
error IError

EnrichValidateDocument(IRequestContext, Activity) 

public virtual void EnrichValidateDocument(IRequestContext context, Activity activity)

Parameters

context IRequestContext
activity Activity

EnrichValidationError(IRequestContext, Activity, IError) 

public virtual void EnrichValidationError(IRequestContext context, Activity activity, IError error)

Parameters

context IRequestContext
activity Activity
error IError