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

docs: update observability/telemetry overview pages #6563

Merged
merged 38 commits into from
Feb 7, 2025

Conversation

Meschreiber
Copy link
Contributor

@Meschreiber Meschreiber commented Jan 16, 2025

This PR:

  • Updates the observability overview to:
    • Prioritize using GraphOS Insights when possible
    • Explain that you can add additional telemetry via router configuration
  • Updates the telemetry overview to:
    • Act as a telemetry primer for those who are new to it
    • Give example telemetry configurations
  • Adds a client observability overview as drafted by @smyrick
  • Adds the telemetry context to page frontmatter so that telemetry-specific terms get hover text per Apollopedia's latest release

@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Jan 16, 2025

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

1 new, 0 changed, 0 removed
+ graphos/reference/migration/from-router-v1.mdx

Build ID: 54a6911a7d270c0c410cfb53

URL: https://www.apollographql.com/docs/deploy-preview/54a6911a7d270c0c410cfb53

Copy link
Contributor

@Meschreiber, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

@Meschreiber
Copy link
Contributor Author

!docs set-base-branch main

@Meschreiber Meschreiber changed the title [WIP] docs: update o11y/telemetry overview pages docs: update observability/telemetry overview pages Jan 22, 2025
@Meschreiber Meschreiber marked this pull request as ready for review January 22, 2025 23:04
@Meschreiber Meschreiber requested a review from a team as a code owner January 22, 2025 23:04
@Meschreiber
Copy link
Contributor Author

!docs set-base-branch main

@Meschreiber Meschreiber added the backport-1.x Backport this PR to 1.x label Jan 23, 2025
Copy link
Contributor

@shorgi shorgi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Reviewed observability intro

docs/source/routing/observability/index.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/index.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/index.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/index.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/telemetry.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/telemetry.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/telemetry.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/telemetry.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/telemetry.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/telemetry.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/telemetry.mdx Outdated Show resolved Hide resolved
Map GraphQL error data to OTel errors with the following configuration:

```yaml title="router.yaml" showLineNumbers=false
telemetry:
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, it seems the commit that adds these configs is causing Circle CI tests that validate configs to fail.

image

When testing them in VS Code with router config awareness, they didn't throw any issues though. 🤔

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How sensitive are the tests to whitespace? For example, this bit:

              static: error
              condition:
                eq:
                - true
                - on_graphql_error: true

looks indented a bit more than the rest

@Meschreiber Meschreiber merged commit e5359ca into dev Feb 7, 2025
16 checks passed
@Meschreiber Meschreiber deleted the docs/ms/update-telemetry-overview branch February 7, 2025 21:16
@Meschreiber
Copy link
Contributor Author

@Mergifyio backport 1.x

Copy link
Contributor

mergify bot commented Feb 7, 2025

backport 1.x

✅ Backports have been created

mergify bot pushed a commit that referenced this pull request Feb 7, 2025
Co-authored-by: Edward Huang <[email protected]>
Co-authored-by: Shane Myrick <[email protected]>
(cherry picked from commit e5359ca)

# Conflicts:
#	docs/source/reference/router/telemetry/instrumentation/standard-instruments.mdx
Meschreiber added a commit that referenced this pull request Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport-1.x Backport this PR to 1.x
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants