Skip to content

Fix increased memory usage in sysinfo since Router 1.59.0#6634

Merged
SimonSapin merged 3 commits intodevfrom
simon/rayonless-sysinfo
Jan 24, 2025
Merged

Fix increased memory usage in sysinfo since Router 1.59.0#6634
SimonSapin merged 3 commits intodevfrom
simon/rayonless-sysinfo

Conversation

@SimonSapin
Copy link
Contributor

In version 1.59.0, Apollo Router started using the sysinfo crate to gather metrics about available CPUs and RAM. By default, that crate uses rayon internally to parallelize its handling of system processes. In turn, rayon creates a pool of long-lived threads.

In a particular benchmark on a 32-core Linux server, this caused resident memory use to increase by about 150 MB. This is likely a combination of stack space (which only gets freed when the thread terminates) and per-thread space reserved by the heap allocator to reduce cross-thread synchronization cost.

This regression is now fixed by:

  • Disabling sysinfo’s use of rayon, so the thread pool is not created and system processes information is gathered in a sequential loop.
  • Making sysinfo not gather that information in the first place since Router does not use it.

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.

In version 1.59.0, Apollo Router started using the `sysinfo` crate
to gather metrics about available CPUs and RAM. By default, that crate
uses `rayon` internally to parallelize its handling of system processes.
In turn, rayon creates a pool of long-lived threads.

In a particular benchmark on a 32-core Linux server, this caused resident
memory use to increase by about 150 MB. This is likely a combination of stack space
(which only gets freed when the thread terminates) and per-thread space reserved
by the heap allocator to reduce cross-thread synchronization cost.

This regression is now fixed by:

* Disabling `sysinfo`’s use of `rayon`, so the thread pool is not created
  and system processes information is gathered in a sequential loop.
* Making `sysinfo` not gather that information in the first place
  since Router does not use it.
@SimonSapin SimonSapin requested a review from a team January 23, 2025 16:10
@SimonSapin SimonSapin requested a review from a team as a code owner January 23, 2025 16:10
@svc-apollo-docs
Copy link
Collaborator

svc-apollo-docs commented Jan 23, 2025

✅ Docs preview has no changes

The preview was not built because there were no changes.

Build ID: e45ddb3f97e162a6684ed7c0

@SimonSapin SimonSapin added the backport-1.x Backport this PR to 1.x label Jan 23, 2025
@github-actions

This comment has been minimized.

@router-perf
Copy link

router-perf bot commented Jan 23, 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

@SimonSapin SimonSapin requested a review from a team as a code owner January 23, 2025 16:12
@SimonSapin
Copy link
Contributor Author

@Mergifyio backport 1.59.2

@mergify
Copy link
Contributor

mergify bot commented Jan 23, 2025

backport 1.59.2

✅ Backports have been created

Details

@SimonSapin SimonSapin enabled auto-merge (squash) January 23, 2025 16:19
@SimonSapin SimonSapin merged commit 4c41b28 into dev Jan 24, 2025
@SimonSapin SimonSapin deleted the simon/rayonless-sysinfo branch January 24, 2025 06:25
mergify bot pushed a commit that referenced this pull request Jan 24, 2025
SimonSapin added a commit that referenced this pull request Jan 24, 2025
@SimonSapin
Copy link
Contributor Author

@Mergifyio backport 1.x

@mergify
Copy link
Contributor

mergify bot commented Jan 24, 2025

backport 1.x

✅ Backports have been created

Details

@SimonSapin
Copy link
Contributor Author

@Mergifyio backport 1.59.2

@mergify
Copy link
Contributor

mergify bot commented Jan 24, 2025

backport 1.59.2

✅ Backports have been created

Details

@SimonSapin
Copy link
Contributor Author

@Mergifyio backport 1.59.2

@mergify
Copy link
Contributor

mergify bot commented Jan 24, 2025

backport 1.59.2

✅ Backports have been created

Details

@SimonSapin
Copy link
Contributor Author

I was hoping to make Mergify create a new PR with me impersonated as author but it reuses the old one, even after deleting the branch. So I opened #6643 manually

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

Labels

backport-1.x Backport this PR to 1.x

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants