@opengeoweb/sentry 19.5.1-nightly-20260831
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.
- package/README.md +45 -0
- package/dist/README.md +45 -0
- package/dist/index.d.ts +1 -0
- package/dist/index.esm.js +3039 -0
- package/dist/src/index.d.ts +1 -0
- package/dist/src/lib/components/SentryRecordButton/SentryRecordButton.d.ts +3 -0
- package/dist/src/lib/components/SentryRecordButton/index.d.ts +2 -0
- package/dist/src/lib/components/UserMenuItemSentryRecording/UserMenuItemSentryRecording.d.ts +7 -0
- package/dist/src/lib/sentry.d.ts +2 -0
- package/dist/src/lib/utils/i18n.d.ts +7 -0
- package/package.json +41 -0
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Sentry
|
|
2
|
+
|
|
3
|
+
This library bring capabilities to use Sentry as a telemetry solution in geoweb.
|
|
4
|
+
|
|
5
|
+
### Nx monorepo and depedencies
|
|
6
|
+
|
|
7
|
+
When using nx monorepo, the components of this library should be used only in the main application to avoid adding Sentry as a dependency to other libs.
|
|
8
|
+
|
|
9
|
+
### Enable Sentry in Geoweb´s Frontend
|
|
10
|
+
|
|
11
|
+
Add a following key to config.json file to enable Sentry `"GW_FEATURE_INITIALIZE_SENTRY": true`
|
|
12
|
+
|
|
13
|
+
### Sentry Recording
|
|
14
|
+
|
|
15
|
+
To Enable Sentry recording in geoweb application, add the `UserMenuItemSentryRecording` and `SentryCordingButton` components into the application. `UserMenuItemSentryRecording` contains a switch that can be used to display the `SentryCordingButton` and switch on this functionality.
|
|
16
|
+
|
|
17
|
+
## Deployment Requirements
|
|
18
|
+
|
|
19
|
+
### CI/CD Configuration
|
|
20
|
+
|
|
21
|
+
For source map uploads to work, the following environment variable must be configured in your CI/CD pipeline:
|
|
22
|
+
|
|
23
|
+
- `SENTRY_AUTH_TOKEN` - Auth token with `project:releases` and `org:read` permissions from Sentry. [Read more about the auth token here](https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens).
|
|
24
|
+
|
|
25
|
+
The custom webpack configuration in [custom-webpack.config.js](../../custom-webpack.config.js) automatically handles source map generation and upload when `SENTRY_AUTH_TOKEN` is present. During local development (without the token), source maps are not uploaded to Sentry.
|
|
26
|
+
|
|
27
|
+
### Web Server Configuration
|
|
28
|
+
|
|
29
|
+
For JavaScript profiling to function, add this HTTP header to your deployment:
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
Document-Policy: js-profiling
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
This header must be present on HTML document responses (the initial page load). It can be configured at various layers:
|
|
36
|
+
|
|
37
|
+
- Application web server (nginx.conf, Apache, IIS, etc.)
|
|
38
|
+
- Reverse proxy/Load balancer
|
|
39
|
+
- Kubernetes Ingress controller annotations
|
|
40
|
+
- CDN/Edge configuration
|
|
41
|
+
|
|
42
|
+
## Sentry docs
|
|
43
|
+
|
|
44
|
+
To keep this readme minimal, you can read more from the official Sentry docs
|
|
45
|
+
https://docs.sentry.io
|
package/dist/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# Sentry
|
|
2
|
+
|
|
3
|
+
This library bring capabilities to use Sentry as a telemetry solution in geoweb.
|
|
4
|
+
|
|
5
|
+
### Nx monorepo and depedencies
|
|
6
|
+
|
|
7
|
+
When using nx monorepo, the components of this library should be used only in the main application to avoid adding Sentry as a dependency to other libs.
|
|
8
|
+
|
|
9
|
+
### Enable Sentry in Geoweb´s Frontend
|
|
10
|
+
|
|
11
|
+
Add a following key to config.json file to enable Sentry `"GW_FEATURE_INITIALIZE_SENTRY": true`
|
|
12
|
+
|
|
13
|
+
### Sentry Recording
|
|
14
|
+
|
|
15
|
+
To Enable Sentry recording in geoweb application, add the `UserMenuItemSentryRecording` and `SentryCordingButton` components into the application. `UserMenuItemSentryRecording` contains a switch that can be used to display the `SentryCordingButton` and switch on this functionality.
|
|
16
|
+
|
|
17
|
+
## Deployment Requirements
|
|
18
|
+
|
|
19
|
+
### CI/CD Configuration
|
|
20
|
+
|
|
21
|
+
For source map uploads to work, the following environment variable must be configured in your CI/CD pipeline:
|
|
22
|
+
|
|
23
|
+
- `SENTRY_AUTH_TOKEN` - Auth token with `project:releases` and `org:read` permissions from Sentry. [Read more about the auth token here](https://docs.sentry.io/product/accounts/auth-tokens/#organization-auth-tokens).
|
|
24
|
+
|
|
25
|
+
The custom webpack configuration in [custom-webpack.config.js](../../custom-webpack.config.js) automatically handles source map generation and upload when `SENTRY_AUTH_TOKEN` is present. During local development (without the token), source maps are not uploaded to Sentry.
|
|
26
|
+
|
|
27
|
+
### Web Server Configuration
|
|
28
|
+
|
|
29
|
+
For JavaScript profiling to function, add this HTTP header to your deployment:
|
|
30
|
+
|
|
31
|
+
```
|
|
32
|
+
Document-Policy: js-profiling
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
This header must be present on HTML document responses (the initial page load). It can be configured at various layers:
|
|
36
|
+
|
|
37
|
+
- Application web server (nginx.conf, Apache, IIS, etc.)
|
|
38
|
+
- Reverse proxy/Load balancer
|
|
39
|
+
- Kubernetes Ingress controller annotations
|
|
40
|
+
- CDN/Edge configuration
|
|
41
|
+
|
|
42
|
+
## Sentry docs
|
|
43
|
+
|
|
44
|
+
To keep this readme minimal, you can read more from the official Sentry docs
|
|
45
|
+
https://docs.sentry.io
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
export * from "./src/index";
|