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

Document enhanced tracing in Studio via OTel #5967

Merged
merged 5 commits into from
Oct 31, 2024

Conversation

timbotnik
Copy link
Contributor

@timbotnik timbotnik commented Sep 6, 2024

Officially document enhanced tracing via OTel. This is currently marked experimental and we've started to get some usage of this feature. Time to make it more visible.

Fixes #712


Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Tests added and passing3
    • Unit Tests
    • Integration Tests
    • Manual Tests

Exceptions

Note any exceptions here

Notes

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

Copy link
Contributor

github-actions bot commented Sep 6, 2024

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

@router-perf
Copy link

router-perf bot commented Sep 6, 2024

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

@timbotnik timbotnik force-pushed the timbotnik/ROUTER-712/document-otel-studio-path branch 2 times, most recently from 36c3142 to 570c4ee Compare September 6, 2024 03:51
@timbotnik timbotnik force-pushed the timbotnik/ROUTER-712/document-otel-studio-path branch from 570c4ee to 1891344 Compare September 6, 2024 04:00
@timbotnik timbotnik marked this pull request as ready for review September 6, 2024 04:01
@timbotnik timbotnik requested a review from a team as a code owner September 6, 2024 04:01
@bnjjj bnjjj requested a review from shorgi September 6, 2024 07:27
docs/source/configuration/overview.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/apollo-telemetry.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/apollo-telemetry.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/apollo-telemetry.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/apollo-telemetry.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/apollo-telemetry.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/apollo-telemetry.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/apollo-telemetry.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/apollo-telemetry.mdx Outdated Show resolved Hide resolved
docs/source/configuration/telemetry/apollo-telemetry.mdx Outdated Show resolved Hide resolved
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Oct 29, 2024

✅ Docs Preview Ready

No new or changed pages found.

@apollographql apollographql deleted a comment from Meschreiber Oct 30, 2024
@timbotnik timbotnik merged commit a213c58 into dev Oct 31, 2024
13 of 15 checks passed
@timbotnik timbotnik deleted the timbotnik/ROUTER-712/document-otel-studio-path branch October 31, 2024 01:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants