-
Notifications
You must be signed in to change notification settings - Fork 275
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
base: dev
Are you sure you want to change the base?
Conversation
✅ Docs preview has no changesThe preview was not built because there were no changes. Build ID: 1c7845b4fd9e551ccee7baee |
@Meschreiber, please consider creating a changeset entry in |
!docs set-base-branch main |
views: | ||
- name: apollo_router* | ||
aggregation: drop | ||
``` | ||
|
||
### Balancing telemetry and router performance |
There was a problem hiding this comment.
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 |
There was a problem hiding this comment.
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.
!docs set-base-branch main |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Reviewed observability intro
Co-authored-by: Edward Huang <[email protected]>
|
||
An individual metric is called an _instrument_. Example instruments of the router include: | ||
This configuration snippet enables exporting metrics to Prometheus: |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
Co-authored-by: Edward Huang <[email protected]>
Co-authored-by: Edward Huang <[email protected]>
This PR: