@sentry/ember 6.17.6 → 6.17.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/README.md +52 -21
  2. package/package.json +5 -5
package/README.md CHANGED
@@ -54,24 +54,55 @@ export default class App extends Application {
54
54
 
55
55
  ### Additional Configuration
56
56
 
57
- Aside from configuration passed from this addon into `@sentry/browser` via the `sentry` property, there is also the following Ember specific configuration.
57
+ Aside from configuration passed from this addon into `@sentry/browser` via the `sentry` property, there is also the following Ember specific configuration:
58
58
 
59
59
  ```javascript
60
- ENV['@sentry/ember'] = {
61
- ignoreEmberOnErrorWarning: false, // Will silence Ember.onError warning without the need of using Ember debugging tools. False by default.
62
- sentry: ... // See sentry-javascript configuration https://docs.sentry.io/error-reporting/configuration/?platform=javascript
63
- };
60
+ ENV['@sentry/ember'] = {
61
+ // Will silence Ember.onError warning without the need of using Ember debugging tools.
62
+ ignoreEmberOnErrorWarning: false,
63
+
64
+ // Will disable automatic instrumentation of performance.
65
+ // Manual instrumentation will still be sent.
66
+ disablePerformance: true,
67
+
68
+ // All runloop queue durations will be added as spans.
69
+ minimumRunloopQueueDuration: 0,
70
+
71
+ // Will disable automatic instrumentation for components.
72
+ disableInstrumentComponents: true,
73
+
74
+ // All (non-glimmer) component render durations will be added as spans.
75
+ minimumComponentRenderDuration: 0,
76
+
77
+ // All component definitions will be added as spans.
78
+ enableComponentDefinition: true,
79
+
80
+ // See sentry-javascript configuration https://docs.sentry.io/error-reporting/configuration/?platform=javascript
81
+ sentry: {}
82
+ };
83
+ ```
84
+
85
+ You can also pass additional configuration for sentry-javascript directly to the `InitSentryForEmber` method.
86
+ This configuration will be merged with `ENV['@sentry/ember'].sentry`:
87
+
88
+ ```javascript
89
+ InitSentryForEmber({
90
+ ignoreErrors: [
91
+ /You appear to be offline/,
92
+ ],
93
+ })
64
94
  ```
65
95
 
96
+ It is recommended to pass all static sentry-javascript configuration directly to `InitSentryForEmber`, and only keeping configuration that depends on the build environment/secrets in `config/environment.js`. Please note that due to how the environment config is serialized, any non-JSON-serializable config (like a regex) will not work properly when being kept in `config/environment.js`.
97
+
66
98
  #### Disabling Performance
67
99
 
68
100
  `@sentry/ember` captures performance by default, if you would like to disable the automatic performance instrumentation, you can add the following to your `config/environment.js`:
69
101
 
70
102
  ```javascript
71
- ENV['@sentry/ember'] = {
72
- disablePerformance: true, // Will disable automatic instrumentation of performance. Manual instrumentation will still be sent.
73
- sentry: ... // See sentry-javascript configuration https://docs.sentry.io/error-reporting/configuration/?platform=javascript
74
- };
103
+ ENV['@sentry/ember'] = {
104
+ disablePerformance: true, // Will disable automatic instrumentation of performance. Manual instrumentation will still be sent.
105
+ };
75
106
  ```
76
107
 
77
108
 
@@ -100,9 +131,9 @@ such as when using glimmer components.
100
131
 
101
132
  If you would like to change the runloop queue threshold, add the following to your config:
102
133
  ```javascript
103
- ENV['@sentry/ember'] = {
104
- minimumRunloopQueueDuration: 0, // All runloop queue durations will be added as spans.
105
- };
134
+ ENV['@sentry/ember'] = {
135
+ minimumRunloopQueueDuration: 0, // All runloop queue durations will be added as spans.
136
+ };
106
137
  ```
107
138
 
108
139
  #### Components
@@ -110,17 +141,17 @@ Non-glimmer component render times will automatically get captured.
110
141
 
111
142
  If you would like to disable component render being instrumented, add the following to your config:
112
143
  ```javascript
113
- ENV['@sentry/ember'] = {
114
- disableInstrumentComponents: true, // Will disable automatic instrumentation for components.
115
- };
144
+ ENV['@sentry/ember'] = {
145
+ disableInstrumentComponents: true, // Will disable automatic instrumentation for components.
146
+ };
116
147
  ```
117
148
 
118
149
  Additionally, components whose render time is below a threshold (by default 2ms) will not be included as spans.
119
150
  If you would like to change this threshold, add the following to your config:
120
151
  ```javascript
121
- ENV['@sentry/ember'] = {
122
- minimumComponentRenderDuration: 0, // All (non-glimmer) component render durations will be added as spans.
123
- };
152
+ ENV['@sentry/ember'] = {
153
+ minimumComponentRenderDuration: 0, // All (non-glimmer) component render durations will be added as spans.
154
+ };
124
155
  ```
125
156
 
126
157
  #### Glimmer components
@@ -128,9 +159,9 @@ Currently glimmer component render durations can only be captured indirectly via
128
159
  optionally enable a setting to show component definitions (which will indicate which components are being rendered) be
129
160
  adding the following to your config:
130
161
  ```javascript
131
- ENV['@sentry/ember'] = {
132
- enableComponentDefinition: true, // All component definitions will be added as spans.
133
- };
162
+ ENV['@sentry/ember'] = {
163
+ enableComponentDefinition: true, // All component definitions will be added as spans.
164
+ };
134
165
  ```
135
166
 
136
167
  ### Supported Versions
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@sentry/ember",
3
- "version": "6.17.6",
3
+ "version": "6.17.9",
4
4
  "description": "Official Sentry SDK for Ember.js",
5
5
  "repository": "git://github.com/getsentry/sentry-javascript.git",
6
6
  "homepage": "https://github.com/getsentry/sentry-javascript/tree/master/packages/ember",
@@ -31,10 +31,10 @@
31
31
  },
32
32
  "dependencies": {
33
33
  "@embroider/macros": "~0.47.2",
34
- "@sentry/browser": "6.17.6",
35
- "@sentry/tracing": "6.17.6",
36
- "@sentry/types": "6.17.6",
37
- "@sentry/utils": "6.17.6",
34
+ "@sentry/browser": "6.17.9",
35
+ "@sentry/tracing": "6.17.9",
36
+ "@sentry/types": "6.17.9",
37
+ "@sentry/utils": "6.17.9",
38
38
  "ember-auto-import": "^1.12.0 || ^2.2.0",
39
39
  "ember-cli-babel": "~7.26.6",
40
40
  "ember-cli-htmlbars": "^6.0.1",