📈 pass through runTelemetry option from landing page configs to embeds #7504
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✅ Deploy Preview for apollo-server-docs ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit 1a57505:
|
mayakoneval
force-pushed
the
maya/NBLA-2242/runTelemetry-in-landing-pages
branch
from
a153580
to
1711044
Compare
trevor-scheer
requested changes
Apr 17, 2023
.changeset/honest-donuts-sparkle.md
Outdated
| '@apollo/server': minor | ||
| --- | ||
|
|
||
| Add runTelemetry boolean option to embedded landing pages |
There was a problem hiding this comment.
Will you please provide a brief explanation of what this config option does (and maybe the telemetry we collect)?
A little code snippet to show how to configure the plugin with this option would be great too.
There was a problem hiding this comment.
Yes, I wasn't sure if we wanted to make this super public, but I don't see why we wouldn't. I'll update with the docs and this! 🙏🏻
Co-authored-by: Trevor Scheer <trevor.scheer@gmail.com>
Co-authored-by: Trevor Scheer <trevor.scheer@gmail.com>
….com:mayakoneval/apollo-server into maya/NBLA-2242/runTelemetry-in-landing-pages
Comment on lines
+11
to
+29
| ``` | ||
| const server = new ApolloServer({ | ||
| typeDefs, | ||
| resolvers, | ||
| plugins: [ | ||
| process.env.NODE_ENV === 'production' | ||
| ? ApolloServerPluginLandingPageProductionDefault({ | ||
| graphRef: 'my-graph-id@my-graph-variant', | ||
| embed: { | ||
| runTelemetry: false | ||
| }, | ||
| }) | ||
| : ApolloServerPluginLandingPageLocalDefault({ | ||
| embed: { | ||
| runTelemetry: false | ||
| }, | ||
| }), | ||
| ], | ||
| }); |
There was a problem hiding this comment.
Not sure how to suggest or correctly escape a ``` but this needs one to close.
trevor-scheer
approved these changes
Apr 17, 2023
Merged
trevor-scheer
added a commit
that referenced
this pull request
Apr 17, 2023
In the Apollo Server Landing Page Local config, you can now opt out of the telemetry that Apollo Studio runs in the embedded Sandbox & Explorer landing pages. This telemetry includes Google Analytics for event tracking and Sentry for error tracking. Fixes #7494 --------- Co-authored-by: Trevor Scheer <trevor.scheer@gmail.com>
trevor-scheer
pushed a commit
that referenced
this pull request
Apr 20, 2023
This PR was opened by the [Changesets release](https://github.com/changesets/action) GitHub action. When you're ready to do a release, you can merge this and the packages will be published to npm automatically. If you're not ready to do a release yet, that's fine, whenever you add more changesets to main, this PR will be updated. # Releases ## @apollo/server@4.7.0 ### Minor Changes - [#7504](#7504) [`22a5be934`](22a5be9) Thanks [@mayakoneval](https://github.com/mayakoneval)! - In the Apollo Server Landing Page Local config, you can now opt out of the telemetry that Apollo Studio runs in the embedded Sandbox & Explorer landing pages. This telemetry includes Google Analytics for event tracking and Sentry for error tracking. Example of the new config option: const server = new ApolloServer({ typeDefs, resolvers, plugins: [ process.env.NODE_ENV === 'production' ? ApolloServerPluginLandingPageProductionDefault({ graphRef: 'my-graph-id@my-graph-variant', embed: { runTelemetry: false }, }) : ApolloServerPluginLandingPageLocalDefault({ embed: { runTelemetry: false }, }), ], }); ## @apollo/server-integration-testsuite@4.7.0 ### Patch Changes - [#7509](#7509) [`5c20aa02e`](5c20aa0) Thanks [@renovate](https://github.com/apps/renovate)! - Update `graphql-http` dependency - [#7475](#7475) [`b9ac2d6b2`](b9ac2d6) Thanks [@renovate](https://github.com/apps/renovate)! - Update graphql-http dependency - Updated dependencies \[[`22a5be934`](22a5be9)]: - @apollo/server@4.7.0 Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi! We had a user request the ability to turn off telemetry, lets allow that.
We support this in the embed in this merged PR and in studio in this merged PR
Fixes #7494