Improve docs for configuring the ember SDK #4426
Merged
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
|
We should probably update https://docs.sentry.io/platforms/javascript/guides/ember/ as well, thoughts @k-fish? |
|
This pull request has gone three weeks without activity. In another week, I will close it. But! If you comment or otherwise update it, I will reset the clock, and if you label it "A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀 |
mydea
force-pushed
the
fn/ember-config-docs
branch
from
3d025e2
to
b772a35
Compare
|
I just rebased it on master, should be up to date again. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR updates the docs for configuring the ember SDK.
It started with some build warnings, that actually lead me on the path to figure out that some of my sentry configuration doesn't work as expected.
See the related issue here:
embroider-build/embroider#1082 (comment)
Basically, all config you put in
config/environment.jswill be stored as macro config for the addon. However, both theconfig/environment.jsas well as the macro config are actually serialized, so any non-JSON-compatible stuff will be more or less silently lost. So for example, a regex in your config (which I was using for theignoreErrorsorblacklistUrlsconfigs) will actually not work when being put there.It is already possible to pass this config manually to the
InitSentryForEmbermethod, so this PR only updates the readme to make this clear and shortly explain that using non-scalar config inconfig/environment.jswill not work as expected.