Skip to content

use spawn_blocking for parsing#5582

Merged
Geal merged 22 commits intodevfrom
spawn-blocking-parser
Jul 9, 2024
Merged

use spawn_blocking for parsing#5582
Geal merged 22 commits intodevfrom
spawn-blocking-parser

Conversation

@Geal
Copy link
Contributor

@Geal Geal commented Jul 2, 2024

This leverages the work that @xuorig started in #5235 with a number of necessary follow-up fixes to get it into the shape we'll need to land it.

I have checked manually that the span duplication in the snapshot has no impact on traces reported to aggregators, it's more of an artifact of our way to gather spans in the test.


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.

@Geal Geal requested a review from a team July 2, 2024 08:36
@Geal Geal requested a review from a team as a code owner July 2, 2024 08:36
@router-perf
Copy link

router-perf bot commented Jul 2, 2024

CI performance tests

  • 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

@Geal Geal enabled auto-merge (squash) July 2, 2024 09:47
@Geal
Copy link
Contributor Author

Geal commented Jul 2, 2024

it looks like there's some flakiness in the tests with the snapshots https://app.circleci.com/pipelines/github/apollographql/router/23631/workflows/0230bc91-f65c-47a1-ae33-6128fae26325/jobs/165914?invite=true#step-117-361965_43
@garypen if I cannot fix that tomorrow, can you take over that PR?

@abernix
Copy link
Member

abernix commented Jul 5, 2024

There is indeed an on-going something or another in the tests. @BrynCooke did try to look at this today, but will not be around for the next couple weeks, and I'm not sure will get back to it.

I will highlight that there is still conversation that wasn't answered from the original PR that might be worth discussing:

@xuorig wrote:

Few other questions:

  • Is specific back pressure for the spawn blocking needed at this level? I'm thinking this is fine for now, back pressure can happen as a concurrency limiter / rate limiter at ingress.
  • Would a wait map similar to planning make sense eventually here?

Gary Pennington added 2 commits July 9, 2024 14:37
Gary Pennington added 3 commits July 9, 2024 15:27
Not sure exactly what is happening here, but ...
This might be the solution I've been looking for. Make sure to create
the spawn outside of the call to spawn_blocking.
@Geal Geal merged commit 47a7386 into dev Jul 9, 2024
@Geal Geal deleted the spawn-blocking-parser branch July 9, 2024 16:02
@Geal
Copy link
Contributor Author

Geal commented Jul 9, 2024

Thanks @garypen for finishing that one

@abernix
Copy link
Member

abernix commented Jul 10, 2024

This PR is causing some tests to flake at a somewhat pronounced rate. We believe it's just actually the tests, or the way we tested, but we'll revert this for now.

abernix added a commit that referenced this pull request Jul 10, 2024
garypen pushed a commit that referenced this pull request Jul 15, 2024
The parsing and validation step is a blocking task that can be expensive on large queries. When performed on a tokio executor threads, that thread is unavailable to handle other asynchronous requests in the mean time. Which means that if a lot of large queries come in at once, they could lock up all of the executor threads, and the router then stops handling traffic.
This moves parsing validation in tokio's blocking tasks pool. This is a set of threads allocated purely to blocking tasks, exposing an async interface for the rest of the code, so executor threads can offload the parsing there then go back to the rest of the traffic while the query is parsed. If too many large queries come in at once, the blocking pool might get temporarily used entirely, but this will not affect traffic for other queries that were already parsed and planned, and the request handling timeout can trigger if it waits too long for its query to be parsed.

Co-authored-by: Marc-Andre Giroux <mgiroux@netflix.com>
Co-authored-by: Marc-Andre Giroux <mgiroux0@gmail.com>
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