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: router request lifecycle #6497

Merged
merged 24 commits into from
Feb 4, 2025
Merged

docs: router request lifecycle #6497

merged 24 commits into from
Feb 4, 2025
+337 −267

Conversation

shorgi
Copy link
Contributor

@shorgi shorgi commented Dec 20, 2024 •
edited
Loading

Move router request lifecycle to top-level page, and reorganize/update its content for basic understanding of how router observability and customization happen within it.

See deploy preview from docs-rewrite PR 401

@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Dec 20, 2024 •
edited
Loading

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: 68b2a2008f5f1f55fe1259c5

@github-actions GitHub Actions
Copy link
Contributor

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

@router-perf
Copy link

router-perf bot commented Dec 20, 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

@shorgi
Copy link
Contributor Author

shorgi commented Jan 8, 2025

!docs preview main

@shorgi shorgi changed the title [WIP] docs: router lifecycle docs: router request lifecycle Jan 10, 2025
@shorgi shorgi marked this pull request as ready for review January 10, 2025 22:18
@shorgi shorgi requested a review from a team as a code owner January 10, 2025 22:18
@shorgi shorgi requested review from BrynCooke and removed request for a team January 10, 2025 22:18
@shorgi
Copy link
Contributor Author

shorgi commented Jan 13, 2025

!docs set-base-branch main

shorgi
shorgi commented Jan 13, 2025
View reviewed changes
docs/source/routing/request-lifecycle.mdx
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The new top-level Router Request Lifecycle page

@shorgi
Copy link
Contributor Author

shorgi commented Jan 13, 2025

!docs preview

devfreddy-apollo
devfreddy-apollo reviewed Feb 3, 2025
View reviewed changes
Copy link
Contributor

@devfreddy-apollo devfreddy-apollo left a comment

Choose a reason for hiding this comment

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

Love the changes and diagrams! Left a few comments based on my understandings and experience.

docs/source/routing/request-lifecycle.mdx Outdated Show resolved Hide resolved
docs/shared/router-lifecycle-services.mdx Outdated Show resolved Hide resolved
docs/shared/router-lifecycle-services.mdx Outdated Show resolved Hide resolved
docs/source/routing/request-lifecycle.mdx Outdated Show resolved Hide resolved
docs/source/routing/request-lifecycle.mdx Outdated Show resolved Hide resolved
docs/source/routing/request-lifecycle.mdx Outdated Show resolved Hide resolved
@shorgi shorgi requested a review from Meschreiber February 3, 2025 20:11
Meschreiber
Meschreiber approved these changes Feb 4, 2025
View reviewed changes
Copy link
Contributor

@Meschreiber Meschreiber left a comment

Choose a reason for hiding this comment

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

So much better to have this as a top-level page in the Routing docs! 🙏 Added some suggestions/nits, but nothing blocking on my end!

docs/shared/router-lifecycle-services.mdx Show resolved Hide resolved
docs/shared/router-lifecycle-services.mdx Outdated Show resolved Hide resolved
docs/shared/router-lifecycle-services.mdx Show resolved Hide resolved
docs/source/routing/customization/overview.mdx Outdated Show resolved Hide resolved
docs/source/routing/customization/overview.mdx Show resolved Hide resolved
docs/source/routing/request-lifecycle.mdx Outdated Show resolved Hide resolved
docs/source/routing/request-lifecycle.mdx Outdated Show resolved Hide resolved
docs/source/routing/observability/telemetry.mdx Outdated Show resolved Hide resolved
docs/source/routing/customization/overview.mdx Outdated Show resolved Hide resolved
docs/source/routing/request-lifecycle.mdx Show resolved Hide resolved
@shorgi shorgi added the backport-1.x Backport this PR to 1.x label Feb 4, 2025
@shorgi
Copy link
Contributor Author

shorgi commented Feb 4, 2025

@mergify queue

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 4, 2025 •
edited
Loading

queue

🛑 The pull request has been removed from the queue default

The following conditions don't match anymore:

  • any of: [📌 queue requirement]
    • check-neutral = Mergify Merge Protections
    • check-skipped = Mergify Merge Protections
    • check-success = Mergify Merge Protections
  • any of: [🔀 queue conditions]
    • all of: [📌 queue conditions of queue default]
      • any of: [🛡 GitHub repository ruleset rule]
        • check-neutral = CLA
        • check-skipped = CLA
        • check-success = CLA
      • any of: [🛡 GitHub repository ruleset rule]
        • check-neutral = ci/circleci: check_compliance-amd_linux_build
        • check-skipped = ci/circleci: check_compliance-amd_linux_build
        • check-success = ci/circleci: check_compliance-amd_linux_build
      • any of: [🛡 GitHub repository ruleset rule]
        • check-neutral = ci/circleci: test-amd_linux_test
        • check-skipped = ci/circleci: test-amd_linux_test
        • check-success = ci/circleci: test-amd_linux_test
      • any of: [🛡 GitHub repository ruleset rule]
        • check-neutral = ci/circleci: test-arm_linux_test
        • check-skipped = ci/circleci: test-arm_linux_test
        • check-success = ci/circleci: test-arm_linux_test
      • any of: [🛡 GitHub repository ruleset rule]
        • check-neutral = ci/circleci: test-macos_test
        • check-skipped = ci/circleci: test-macos_test
        • check-success = ci/circleci: test-macos_test
      • any of: [🛡 GitHub repository ruleset rule]
        • check-neutral = ci/circleci: test-windows_test
        • check-skipped = ci/circleci: test-windows_test
        • check-success = ci/circleci: test-windows_test
      • any of: [🛡 GitHub repository ruleset rule]
        • check-neutral = Mergify Merge Protections
        • check-skipped = Mergify Merge Protections
        • check-success = Mergify Merge Protections

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 4, 2025

This pull request has been removed from the queue for the following reason: checks failed.

The merge conditions cannot be satisfied due to failing checks

You should look at the reason for the failure and decide if the pull request needs to be fixed or if you want to requeue it.

If you want to requeue this pull request, you need to post a comment with the text: @mergifyio requeue

@shorgi
Copy link
Contributor Author

shorgi commented Feb 4, 2025

@mergify update

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 4, 2025

update

☑️ Nothing to do

  • #commits-behind > 0 [📌 update requirement]
  • -closed [📌 update requirement]
  • -conflict [📌 update requirement]
  • queue-position = -1 [📌 update requirement]

@shorgi
Copy link
Contributor Author

shorgi commented Feb 4, 2025

@mergify queue

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 4, 2025 •
edited
Loading

queue

✅ The pull request has been merged automatically

The pull request has been merged automatically at a4bbf5d

@shorgi
Copy link
Contributor Author

shorgi commented Feb 4, 2025

@mergify refresh

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 4, 2025

refresh

✅ Pull request refreshed

@mergify mergify bot merged commit a4bbf5d into dev Feb 4, 2025
17 checks passed
@mergify mergify bot deleted the eh/DOC-279/router-lifecycle branch February 4, 2025 22:08
@shorgi
Copy link
Contributor Author

shorgi commented Feb 5, 2025

@Mergifyio backport 1.x

@mergify Mergify
Copy link
Contributor

mergify bot commented Feb 5, 2025 •
edited
Loading

backport 1.x

❌ No backport have been created

  • Backport to branch 1.x failed

Git reported the following error:

error: commit fcb63e6858171d545c87fc2e5c0e0e2f5aaa4583 is a merge but no -m option was given.
fatal: cherry-pick failed

@shorgi shorgi mentioned this pull request Feb 5, 2025
Merged
@goto-bus-stop
Copy link
Member

@shorgi This PR removed the Context Keys section that was introduced in #6572. was that intentional?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@devfreddy-apollo devfreddy-apollo devfreddy-apollo left review comments

@Meschreiber Meschreiber Meschreiber approved these changes

@BrynCooke BrynCooke Awaiting requested review from BrynCooke

Assignees
No one assigned
Labels
backport-1.x Backport this PR to 1.x
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@shorgi @svc-apollo-docs @goto-bus-stop @Meschreiber @devfreddy-apollo