|
1 | 1 | --- |
2 | 2 | title: "Set Up" |
3 | 3 | sidebar_order: 10 |
4 | | -description: "Get started with Sentry's Dev Toolbar, bringing critical Sentry insights and tools into your web app to help your team troubleshoot more effectively.." |
| 4 | +description: "Get started with Sentry's Dev Toolbar, bringing critical Sentry insights and tools into your web app to help your team troubleshoot more effectively." |
5 | 5 | --- |
6 | 6 |
|
7 | 7 | <Alert level="info"> |
@@ -100,20 +100,20 @@ window.SentryToolbar.init({ |
100 | 100 |
|
101 | 101 | | Field Name | Type | Description | Default Value | |
102 | 102 | | ----- | ----- | ----- | ----- | |
103 | | -| `organizationSlug` | `string` | The organization that users should login to. For example \`acme\` | *Required Value* | |
| 103 | +| `organizationSlug` | `string` | The organization that users should login to. For example \'acme\' | *Required Value* | |
104 | 104 | | `projectIdOrSlug` | `string \| number` | The project for which this website/webapp is associated. | *Required Value* | |
105 | | -| `environment (optional)` | `string \| string[] \| undefined` | The environment of this deployment. Used to narrow search results in the Toolbar UI. Set to \`undefined\` or \`””\` or \`\[\]\` if you want to see results from all environments. | `undefined` | |
106 | | -| `placement (optional)` | `'right-edge' \| 'bottom-right-corner'` | Where to render the toolbar on the screen. | `"right-edge"` | |
107 | | -| `theme (optional)` | `'system' \| 'dark' \| 'light'` | Whether to use dark or light mode. | `"system"` | |
| 105 | +| `environment (optional)` | `string \| string[] \| undefined` | The environment of this deployment. Used to narrow search results in the Toolbar UI. Set to `undefined` or `""` or `\[\]` if you want to see results from all environments. | `undefined` | |
| 106 | +| `placement (optional)` | `'right-edge' \| 'bottom-right-corner'` | Where to render the toolbar on the screen. | `'right-edge'` | |
| 107 | +| `theme (optional)` | `'system' \| 'dark' \| 'light'` | Whether to use dark or light mode. | `'system'` | |
108 | 108 | | `featureFlags (optional)` | `FeatureFlagAdapter \| undefined` | See [Implement FeatureFlagAdapter](/product/dev-toolbar/setup//#implement-feature-flag-adapter) above | `undefined` | |
109 | | -| `sentryOrigin (optional)` | `string \| undefined` | The origin where Sentry can be found. Used for loading the connection to Sentry, and generating links to the website. For example: \`"[https://acme.sentry.io]"\` | `"https://sentry.io"` | |
110 | | -| `domId (optional)` | `string \| undefined` | The \`id\` given to the \<div\> that is created to contain the toolbar html. | `"sentry-toolbar"` | |
111 | | -| `debug (optional)` | `string \| undefined` | A comma separated string of debug targets to enable. Example: `"logging,state"` If the list contains ”all” or ”true” then all targets will be enabled. Valid targets: `"logging" "login-success" "settings" "state"` | `undefined` | |
| 109 | +| `sentryOrigin (optional)` | `string \| undefined` | The origin where Sentry can be found. Used for loading the connection to Sentry, and generating links to the website. For example: `'[https://acme.sentry.io]'` | `'https://sentry.io'` | |
| 110 | +| `domId (optional)` | `string \| undefined` | The `id` given to the \<div\> that is created to contain the toolbar html. | `'sentry-toolbar'` | |
| 111 | +| `debug (optional)` | `string \| undefined` | A comma separated string of debug targets to enable. Example: `'logging,state'`. If the list contains 'all' or 'true' then all targets will be enabled. Valid targets: `'logging' 'login-success' 'settings' 'state'` | `undefined` | |
112 | 112 | | `mountPoint (optional)` | `HTMLElement \| () => HTMLElement \| undefined` | Where to mount the toolbar in the DOM. | `document.body` | |
113 | 113 |
|
114 | 114 |
|
115 | 115 | ## Deploying To Production & Dev Environments |
116 | | -Since the Dev Toolbar is deployed onto specific pages, it's strongly recommended that you consider which environments your app is deployed to should have the toolbar available. |
| 116 | +Since the Dev Toolbar is deployed onto specific pages, it's strongly recommended that you consider which environments the toolbar should apply to. |
117 | 117 |
|
118 | 118 | In dev and staging environments, you might want to *unconditionally* include the toolbar so that all developers and testers can use it and quickly go from the page they're looking at back to Sentry for further debugging. |
119 | 119 |
|
|
0 commit comments