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

Add a histogram metric tracking evaluated query plans #5875

Merged
merged 9 commits into from
Sep 4, 2024

Conversation

Geal
Copy link
Contributor

@Geal Geal commented Aug 23, 2024

the max_evaluated_plans option can be used to limit the number of query plans evaluated for a query, but there was no way to know what is a reasonable value for that option. This adds a histogram metric tracking the number of evaluated query plans, which should give more context to configure this.

This cannot be merged until apollographql/federation-rs#566 is merged and router-bridge published (This is done as v0.6.1+v2.9.0)


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.

the `experimental_plans_limit` option can be used to limit the number of query plans evaluated for a query, but there was no way to know what is a reasonable value for that option. This adds a histogram metric tracking the number of evaluated query plans, which should give more context to configure this.

This comment has been minimized.

@router-perf
Copy link

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

Copy link
Member

@lrlna lrlna left a comment

Choose a reason for hiding this comment

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

could this have some tests too? 😇

apollo-router/src/query_planner/bridge_query_planner.rs Outdated Show resolved Hide resolved
@Geal Geal marked this pull request as ready for review September 3, 2024 14:34
@Geal Geal requested review from a team as code owners September 3, 2024 14:34
@Geal Geal requested a review from a team as a code owner September 3, 2024 14:42
@Geal Geal enabled auto-merge (squash) September 3, 2024 16:33
@Geal Geal merged commit 48c03cf into dev Sep 4, 2024
14 checks passed
@Geal Geal deleted the geal/evaluate-plan-count branch September 4, 2024 07:47
@abernix abernix mentioned this pull request Sep 10, 2024
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.

3 participants