View Source OpenTelemetry.SemConv.Incubating.GraphqlAttributes (OpenTelemetry.SemConv v1.27.0)

OpenTelemetry Semantic Conventions for Graphql attributes.

Summary

Types

The type of the operation being executed.

Functions

The GraphQL document being executed.

The name of the operation being executed.

The type of the operation being executed.

Types

Link to this type

graphql_operation_type_values()

View Source
@type graphql_operation_type_values() :: %{
  query: :query,
  mutation: :mutation,
  subscription: :subscription
}

The type of the operation being executed.

Enum Values

  • :query e - GraphQL query
  • :mutation e - GraphQL mutation
  • :subscription e - GraphQL subscription

Functions

@spec graphql_document() :: :"graphql.document"

The GraphQL document being executed.

Value type

Value must be of type atom() | String.t().

Notes

The value may be sanitized to exclude sensitive information.

Examples

query findBookById { bookById(id: ?) { name } }
iex> OpenTelemetry.SemConv.Incubating.GraphqlAttributes.graphql_document()
:"graphql.document"
Link to this function

graphql_operation_name()

View Source
@spec graphql_operation_name() :: :"graphql.operation.name"

The name of the operation being executed.

Value type

Value must be of type atom() | String.t().

Examples

findBookById
iex> OpenTelemetry.SemConv.Incubating.GraphqlAttributes.graphql_operation_name()
:"graphql.operation.name"
Link to this function

graphql_operation_type()

View Source
@spec graphql_operation_type() :: :"graphql.operation.type"

The type of the operation being executed.

Examples

["query", "mutation", "subscription"]
iex> OpenTelemetry.SemConv.Incubating.GraphqlAttributes.graphql_operation_type()
:"graphql.operation.type"

iex> OpenTelemetry.SemConv.Incubating.GraphqlAttributes.graphql_operation_type_values().query
:query

iex> %{OpenTelemetry.SemConv.Incubating.GraphqlAttributes.graphql_operation_type() => OpenTelemetry.SemConv.Incubating.GraphqlAttributes.graphql_operation_type_values().query}
%{:"graphql.operation.type" => :query}
Link to this function

graphql_operation_type_values()

View Source
@spec graphql_operation_type_values() :: graphql_operation_type_values()