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

docs: update/annotate formerly experimental configs #5938

Merged
merged 3 commits into from
Sep 4, 2024

Conversation

Meschreiber
Copy link
Contributor

This PR removes the <ExperimentalFeature> annotation for two configs that are no longer experimental and adds a note for when they became generally available. I considered adding the following text to the note, but found it unnecessary.

Router configurations with telemetry.apollo.experimental_apollo_metrics_reference_mode will continue to work, but Apollo recommends updating the configuration to telemetry.apollo.metrics_reference_mode.

Happy to add it back if others deem it's helpful.

See #5807 for more info.

@Meschreiber Meschreiber requested a review from a team as a code owner September 3, 2024 14:51
Copy link
Contributor

github-actions bot commented Sep 3, 2024

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

@router-perf
Copy link

router-perf bot commented Sep 3, 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

docs/source/configuration/overview.mdx Outdated Show resolved Hide resolved
docs/source/configuration/overview.mdx Outdated Show resolved Hide resolved
<Note>

Beginning with [v1.49.0](https://github.com/apollographql/router/releases/tag/v1.49.0), the router supported enhanced operation signature normalization [experimentally](/resources/product-launch-stages/#experimental-features).
In [v.1.53.0](https://github.com/apollographql/router/releases/tag/v1.53.0), this configuration became [generally available](/resources/product-launch-stages/#general-availability).
Copy link
Contributor

Choose a reason for hiding this comment

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

The config rename will happen in v1.54.0, so we should use that as the version it became GA (and not merge this until then).

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is merging into dev, so I think we can/should merge before the release, right?

Copy link
Member

@abernix abernix Sep 4, 2024

Choose a reason for hiding this comment

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

Yes! We'll start 1.54.0 (as a release candidate) today and this will not land in our docs until next Tuesday when we finalize 1.54.0. 😄 I'll merge this to make sure it makes the cut. (It looks like the version was already raised to 1.54.0 in the text, which is totes right.)

@abernix abernix merged commit dccab4e into dev Sep 4, 2024
13 of 14 checks passed
@abernix abernix deleted the docs/update-experimental-configs branch September 4, 2024 09:29
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