Different installation instructions in documentation for Ember and readme for @sentry/ember package

[jelhan]

Is there an existing issue for this?

• I have checked for existing issues https://github.com/getsentry/sentry-javascript/issues
• I have reviewed the documentation https://docs.sentry.io/
• I am using the latest SDK release https://github.com/getsentry/sentry-javascript/releases

How do you use Sentry?

Self-hosted/on-premise

Which package are you using?

@sentry/ember

SDK Version

7.0.0

Framework Version

No response

Link to Sentry event

No response

Steps to Reproduce

Compare setup instructions in Configure chapter of https://docs.sentry.io/platforms/javascript/guides/ember/#configure with setup instructions in Usage chapter of https://github.com/getsentry/sentry-javascript/tree/master/packages/ember#usage. The first one is also shown in the application when choosing Ember as framework for a new project.

Expected Result

I expect that the instructions how to use @sentry/ember package are the same on docs.sentry.io, in the applicaiton and in the readme of the NPM package.

Actual Result

Documentation at https://docs.sentry.io/platforms/javascript/guides/ember/#configure asks me to put the following code in the app/app.js:

import * as Sentry from "@sentry/ember";

Sentry.init({
  dsn: "https://examplePublicKey@o0.ingest.sentry.io/0",

  // Set tracesSampleRate to 1.0 to capture 100%
  // of transactions for performance monitoring.
  // We recommend adjusting this value in production,
  tracesSampleRate: 1.0,
});

The documentation shown in the application when selecting Ember for a new project is the same beside actually containing the DSN for the project.

README of the NPM package asks me to put the following code in the same file:

import { InitSentryForEmber } from '@sentry/ember';

InitSentryForEmber();

Additionally it asks me to put configuration for Sentry in config/environment.js.

The documentation in the NPM package seems to be more up to date. I followed that one successfully. But that is only gut feeling. I didn't verified if the other instructions are working as well with latest version of the SDK. And I did not had a look which documentation is newer.

[Lms24]

Hi @jelhan and thanks for reporting! You're right of course, our documentation should be consistent and up to date everywhere.

Since my knowledge on Ember is rather limited you think that the instructions on the setup in the README.md file are more accurate, right? I'll add this to our backlog to consolidate the two versions.

Maybe @k-fish, you could take a quick look and confirm with which version to go? Would be greatly appreciated!

[Lms24]

Also, @jelhan if you happen to have some time and ember knowledge at hand, PRs would be very welcome and appreciated ;) Thanks!

[jelhan]

I used the instructions provided in readme of NPM package successfully. I haven't tried the others.

In general the instructions in the readme seem to better align with established patterns in Ember ecosystem. Especially in regards to configuring an addon through config/environment.js or a custom file in config.

I only have very limited time for open source currently. I fear I can't help with a pull request in foreseeable future.

[k-fish]

Thanks for mentioning it to us. The README is the old version before we made some changes to make the Ember sdk more consistent with the rest of our sdks, but more importantly the way Ember initializers work makes it harder to have consistent config when solely providing it through the environment file so we had to make use of Ember macros, which we ran into trouble with when using newer versions of Ember / embroider etc.

If you're familiar with the Ember ecosystem, you can think of providing Sentry specific config (eg. dsn) in the init in app.js like the Sentry docs mention, and keep any addon specific config in the environment file (eg. disabling or enabling specific features).

I'll comb through the README soon and tidy this up to avoid confusion, thanks again 👍