Docs
Launch GraphOS Studio

Router Logging

Configure logging in the Apollo Router


The provides built-in logging to capture records about the router's activity.

The supports configurable log levels and stdout output of log messages (with configurable output formats).

Log level

The accepts a command-line to set its log level:

NameDescription
--log

The log level, indicating the most severe log message type to include. In ascending order of verbosity, can be one of: off, error, warn, info, debug, or trace.

The default value is info.

The also accepts both RUST_LOG and APOLLO_ROUTER_LOG environment variables with the same possible values as the command-line . With multiple ways to set the log level, the checks for them in the following order, and it uses the first one that is set:

  1. RUST_LOG
  2. Command-line
  3. APOLLO_ROUTER_LOG

RUST_LOG is supported for advanced users with specific filtering requirements who may wish to see log messages from crates consumed by the . Most users should use the command-line or APOLLO_ROUTER_LOG. Both of these options constrain log output to the .

For example, every environment variable and command-line below sets the log level to debug:

RUST_LOG=apollo_router::debug
APOLLO_ROUTER_LOG=debug
--log=debug

For another example, every line below sets the same log levels:

RUST_LOG=hyper=debug,apollo_router::info,h2=trace
APOLLO_ROUTER_LOG=hyper=debug,info,h2=trace
--log=hyper=debug,info,h2=trace

In both examples, the actual filter used by the the value defined by RUST_LOG.

For more information about specifying filters for more granular control over logging, see the Env Logger documentation.

Logging common configuration

The supports configuration options that apply to all logging exporters:

Service name

Set a service name for your 's logs so they can be easily searched and found in your metrics dashboards.

The service name can be set by an environment variable or in router.yaml. With multiple ways to set the service name, the checks for them in the following order, and it uses the first one that is set:

  1. OTEL_SERVICE_NAME environment variable

  2. OTEL_RESOURCE_ATTRIBUTES environment variable

  3. telemetry.exporters.logging.common.service_name in router.yaml

  1. telemetry.exporters.logging.common.resource in router.yaml

If the service name isn't explicitly set, then it is set by default to unknown_service:apollo_router (or unknown_service if the executable name cannot be determined).

Resource attribute

A resource attribute is a set of key-value pairs that provide additional information to an exporter. Application performance monitors (APM) may interpret and display resource information.

In router.yaml, resource attributes are set in telemetry.exporters.logging.common.resource. For example:

router.yaml
telemetry:
exporters:
logging:
common:
resource:
"environment.name": "production"
"environment.namespace": "{env.MY_K8_NAMESPACE_ENV_VARIABLE}"

For OpenTelemetry conventions for resources, see Resource Semantic Conventions.

Request/Response logging

This feature is experimental. Your questions and feedback are highly valueddon't hesitate to get in touch with your Apollo contact or on the official Apollo GraphQL Discord. If you want to give feedback or participate in the feature, feel free to join the discussion on GitHub.

By default, the doesn't log the following values that might contain sensitive data, even if a sufficient log level is set:

  • Request bodies
  • Response bodies
  • Headers

You can enable selective logging of these values via the experimental_when_header option:

router.yaml
telemetry:
exporters:
logging:
# If one of these headers matches we will log supergraph and subgraphs requests/responses
experimental_when_header:
- name: apollo-router-log-request
value: my_client
headers: true # default: false
body: true # default: false
# log request for all requests coming from Iphones
- name: user-agent
match: ^Mozilla/5.0 (iPhone*
headers: true

Logging common reference

AttributeDefaultDescription
service_nameunknown_service:routerThe OpenTelemetry service name.
service_namespaceThe OpenTelemetry namespace.
resourceThe OpenTelemetry resource to attach to generated log events.
Previous
Client awareness
Next
Stdout
Edit on GitHubEditForumsDiscord

© 2024 Apollo Graph Inc.

Privacy Policy

Company