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

Open
wants to merge 17 commits into
base: dev
Choose a base branch
from

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 has no changes

The preview was not built because there were no changes.

Build ID: 1c7845b4fd9e551ccee7baee

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
views:
- name: apollo_router*
aggregation: drop
```

### Balancing telemetry and router performance
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Comment from @devfreddy-apollo on this section:

The router team likely has some actual stats on this impact, but it's not something I've seen with customers at all. The router is performant enough to add A LOT of telemetry before this is an issue. It's good to document, but I'm not sure it needs to be prioritized in an opening primer. That might be my personal opinion, though.

This section was originally written by the router team, so I'm inclined to keep it. @BrynCooke would you be able to comment on whether this is worth calling out upfront?


## Best practices
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Comment from @devfreddy-apollo on this section:

Yes! This is an area we should expand on for sure. The router team has opinions, CS should have opinions as well. I have some I've started to aggregate but we should crowd source this too. IMO this is where customers get value from all of these great O11y features, and if we don't tell them or do it by default they aren't going to do it.

I agree that we should add more best practices and recipes but would like to get this out-the-door for now. As we expand about best practices, we can move this subsection to its own page, and perhaps eventually to its own set of pages.

@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

An individual metric is called an _instrument_. Example instruments of the router include:
This configuration snippet enables exporting metrics to Prometheus:
Copy link
Contributor

Choose a reason for hiding this comment

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

Is Datadog the most popular APM now? Should update the example for whatever is the most used

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I used DataDog for the next example to showcase various APMs, but I'm fine with making them all DataDog if that's preferred

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
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.

3 participants