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.

Sign up for GitHub

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

Jump to bottom

[docs] Create debugging-client-requests.mdx #6504

Closed
wants to merge 7 commits into from
Closed

[docs] Create debugging-client-requests.mdx #6504

wants to merge 7 commits into from

Conversation

smyrick
Copy link
Member

@smyrick smyrick commented Jan 2, 2025

Add a docs page about how to debug client requests. This infomation is spread across many different features so this serves as a landing page for all of that.

I don't know how to nest this under the correct sidebar section so maybe help there? I think it should be under Routing > Observability > Client Observability

@smyrick smyrick requested a review from a team as a code owner January 2, 2025 21:38
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Jan 2, 2025 •
edited
Loading

✅ Docs Preview Ready

No new or changed pages found.

@github-actions GitHub Actions

This comment has been minimized.

Sign in to view
@router-perf
Copy link

router-perf bot commented Jan 2, 2025

CI performance tests

  • connectors-const - Connectors stress test that runs with a constant number of users
  • const - Basic stress test that runs with a constant number of users
  • demand-control-instrumented - A copy of the step test, but with demand control monitoring and metrics enabled
  • demand-control-uninstrumented - A copy of the step test, but with demand control monitoring enabled
  • enhanced-signature - Enhanced signature enabled
  • events - Stress test for events with a lot of users and deduplication ENABLED
  • events_big_cap_high_rate - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity
  • events_big_cap_high_rate_callback - Stress test for events with a lot of users, deduplication enabled and high rate event with a big queue capacity using callback mode
  • events_callback - Stress test for events with a lot of users and deduplication ENABLED in callback mode
  • events_without_dedup - Stress test for events with a lot of users and deduplication DISABLED
  • events_without_dedup_callback - Stress test for events with a lot of users and deduplication DISABLED using callback mode
  • extended-reference-mode - Extended reference mode enabled
  • large-request - Stress test with a 1 MB request payload
  • no-tracing - Basic stress test, no tracing
  • reload - Reload test over a long period of time at a constant rate of users
  • step-jemalloc-tuning - Clone of the basic stress test for jemalloc tuning
  • step-local-metrics - Field stats that are generated from the router rather than FTV1
  • step-with-prometheus - A copy of the step test with the Prometheus metrics exporter enabled
  • step - Basic stress test that steps up the number of users over time
  • xlarge-request - Stress test with 10 MB request payload
  • xxlarge-request - Stress test with 100 MB request payload

@Meschreiber
Copy link
Contributor

Thanks for this @smyrick , will review tomorrow!

Re: adding to sidebar, this actually happens in the docs-rewrite repo, and I can submit an adjacent PR to accomplish that.

tushdante
tushdante reviewed Jan 2, 2025
View reviewed changes
Copy link

@tushdante tushdante left a comment

Choose a reason for hiding this comment

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

Thanks for writing this up!

docs/source/routing/observability/debugging-client-requests.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/debugging-client-requests.mdx Outdated
description: Enable telemetry features to help gain more visibility into incoming HTTP requests and help debug issues your clients may be having.
---

GraphOS Router by default does not emit access logs for the incoming client HTTP requests, nor are other features, like OpenTelemetry, on by default that include every request. Given the volume and size of GraphQL requests, this would produce a large amount of telemetry data that may impact your observability costs.
Copy link

Choose a reason for hiding this comment

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

Wording is bit confusing here. Maybe rewrite to something like:
"By default, the GraphOS Router does not generate access logs for incoming client HTTP requests, nor are features like OpenTelemetry enabled to capture every request."

docs/source/routing/observability/debugging-client-requests.mdx Outdated Show resolved Hide resolved
@Meschreiber
Copy link
Contributor

Meschreiber commented Jan 3, 2025 •
edited
Loading

Hey @smyrick , I'm just realizing this is based off dev which means it wouldn't get published until the next router release. (Slated for late January, I believe.) Mind if I make a new branch/PR off of main with my copyedits to get it published sooner? (Likely early next week.)

EDIT: Doing it here: #6507

@Meschreiber
Copy link
Contributor

Closing in favor of #6507

@Meschreiber Meschreiber closed this Jan 3, 2025
@smyrick smyrick deleted the smyrick-patch-2 branch January 3, 2025 18:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@tushdante tushdante tushdante left review comments

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@smyrick @svc-apollo-docs @Meschreiber @tushdante