Tracing

{{ "GraphQL::Tracing::Trace" | api_doc }} provides hooks to observe and modify events during runtime. Tracing hooks are methods, defined in modules and mixed in with {{ "Schema.trace_with" | api_doc }}.

module CustomTrace
  def parse(query_string:)
    # measure, log, etc
    super
  end

  # ...
end

To include a trace module when running queries, add it to the schema with trace_with:

# Run `MyCustomTrace` for all queries
class MySchema < GraphQL::Schema
  trace_with(MyCustomTrace)
end

For a full list of methods and their arguments, see {{ "GraphQL::Tracing::Trace" | api_doc }}.

By default, GraphQL-Ruby makes a new trace instance when it runs a query. You can pass an existing instance as context: { trace: ... }. Also, GraphQL.parse( ..., trace: ...) accepts a trace instance.

Detailed Traces

You can capture detailed traces of query execution with {{ "Tracing::DetailedTrace" | api_doc }}. They can be viewed in Google's Perfetto Trace Viewer. They include a per-Fiber breakdown with links between fields and Dataloader sources.

{{ "/queries/perfetto_example.png" | link_to_img:"GraphQL-Ruby Dataloader Perfetto Trace" }}

Learn how to set it up in the {{ "Tracing::DetailedTrace" | api_doc }} docs.

External Monitoring Platforms

There integrations for GraphQL-Ruby with several other monitoring systems:

• ActiveSupport::Notifications: See {{ "Tracing::ActiveSupportNotificationsTrace" | api_doc }}.
• AppOptics instrumentation is automatic in appoptics_apm v4.11.0+.
• AppSignal: See {{ "Tracing::AppsignalTrace" | api_doc }}.
• Datadog: See {{ "Tracing::DataDogTrace" | api_doc }}.
• NewRelic: See {{ "Tracing::NewRelicTrace" | api_doc }}.
• Prometheus: See {{ "Tracing::PrometheusTrace" | api_doc }}.
• Scout APM: See {{ "Tracing::ScoutTrace" | api_doc }}.
• Sentry: See {{ "Tracing::SentryTrace" | api_doc }}.
• Skylight: either enable the GraphQL probe or use {{ "Tracing::ActiveSupportNotificationsTrace" | api_doc }}.
• Statsd: See {{ "Tracing::StatsdTrace" | api_doc }}.