Skip to content
Merged
Show file tree
Hide file tree
Changes from 8 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 0 additions & 16 deletions docs/product/dev-toolbar/faq.mdx

This file was deleted.

46 changes: 0 additions & 46 deletions docs/product/dev-toolbar/index.mdx

This file was deleted.

66 changes: 66 additions & 0 deletions docs/product/sentry-toolbar/faq.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
---
title: FAQ
sidebar_order: 30
description: "Frequently asked questions about the Sentry Toolbar."
---

<Expandable permalink title="In what environments should I enable the Toolbar?">

Since the Sentry Toolbar will be visible to users within your app, it's important to consider which environments should render it.

If your web application requires authentication to access:
- In development and staging, always initialize the Sentry Toolbar.
- In production, conditionally initialize the Sentry Toolbar when an employee is logged in.

If you web application does not require authenticaion:
- In development and staging environments, initialize the Toolbar at all times.
- In production environments, do not initialize the Toolbar.

Initializing the Sentry Toolbar allows all developers and testers to quickly go from the page they're looking at, back to Sentry for further debugging.
In production it can make it easier for developers to reproduce issues, but it should not be initialized for all users of the site -- only when an employee/engineer/etc visits.

Once you decide where and when you want the Toolbar to appear, you'll write those conditions into your codebase. The specific implementation is something you'll need to write based on how your app works and how your team is set up.

</Expandable>

<Expandable permalink title="How can I conditionally initialize the Toolbar?">

Implementing the specific conditions for initializing the Toolbar will vary from app to app and whichever framework or template library is in use.

For example, the conditions to show the Toolbar in development and staging might look like this, if written in JavaScript:

```html {tabTitle:CDN}
<script>
const env = process.env.ENVIRONMENT || 'development';
const isDev = env === 'development' || env === 'staging';

if (isDev) {
window.SentryToolbar.init({ ... });
}
</script>
```
```javascript {tabTitle:React}
const env = process.env.ENVIRONMENT || 'development';
const isDev = env === 'development' || env === 'staging';

useSentryToolbar({
enabled: isDev,
initProps: {
...
},
})
```

</Expandable>

<Expandable permalink title="Are there plans to include the Toolbar in the JavaScript SDK?">

The [Sentry Toolbar](https://github.com/getsentry/sentry-toolbar) and the [JavaScript SDK](https://github.com/getsentry/sentry-javascript) are distinct features that we intentionally keep separated.

Some of the differences between the two include:
- The Toolbar is a UI product focused on making it easier to find and take action on existing data, while the SDK functions as infrastructure to collect and send data to the server.
- The Toolbar has a different set of [dependencies](https://github.com/getsentry/sentry-toolbar/blob/main/package.json) and uses different browser APIs that the JavaScript SDK does not use. For example: the Toolbar will interact with things like cookies and local storage. By keeping these pieces of code separate, it's easier to audit the [SDK code on GitHub](https://github.com/getsentry/sentry-javascript) to verify that it is not persisting information inside end-users' browsers.
- The setup and deploy instruction are very different. The SDK is best deployed on staging and production environments, and can be configured easily with environment variables. The Sentry Toolbar requires special considerations to deploy it into production, usually by creating a condition so that it's only included for members of your own Sentry organization.

</Expandable>

46 changes: 46 additions & 0 deletions docs/product/sentry-toolbar/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Sentry Toolbar
sidebar_order: 120
description: "Bring critical Sentry insights and tools directly into your web app for easier troubleshooting with the Sentry Toolbar."
---

<Alert>
The Sentry Toolbar is currently in **beta**. Beta features are still in progress and may have bugs. Please reach out on
[GitHub](https://github.com/getsentry/sentry-toolbar/issues) if you have any feedback or concerns.
</Alert>

Developers spend a lot of time troubleshooting their web apps on local, staging, and production environments. The Sentry Toolbar pulls data from [sentry.io](http://sentry.io) and surfaces relevant, actionable issues to you when you have the most context for understanding it: as you browse your own site. The Sentry Toolbar is a floating widget in your web app, offering meaningful Sentry insights for the specific page being viewed through three different **page-aware** panels: Issues, Feedback, and Feature Flags.

![Collapsed Toolbar in context of a website](./img/toolbar-collapsed.png)

## Issues Panel

The issues panel shows you your highest priority frontend [issues](https://docs.sentry.io/product/issues/) for the page you are currently viewing. From the Sentry Toolbar, you can quickly jump into specific issues in Sentry to get more detailed information (examples: Sentry project, issue title, description, and when the issue was first and last seen) and take action (examples: assign to a team member or mark as resolved). With the issues panel, you can browse the pages that are most important to your business and understand the top issues impacting your user base.

![Toolbar with the Issues Panel open](./img/issues-panel.png)

## Feedback Panel

The feedback panel shows you the most recent user feedback messages for the page you are on, so you can more easily contextualize it. The feedback often describes suboptimal experiences that are not strictly code-thrown errors, such as misleading UX, broken links, and typos. The feedback panel works by pulling feedback messages from [Sentry’s User Feedback Widget](https://docs.sentry.io/product/user-feedback/#user-feedback-widget). Just like with the Issues panel, clicking on a particular user feedback will take you to the full detailed User Feedback page within Sentry.

![Toolbar with the Feedback Panel open](./img/feedback-panel.png)

## Feature Flags Panel

Feature flags are a powerful tool that allow you to control the visibility of features in your app, enabling you to ship, test, and experiment with confidence. The feature flag panel allows you to quickly view and override feature flags locally. You can override any feature flag to be `true` or `false` for your browser session, so you can verify its behavior and observe the impact it might have on errors. Learn more about how to [configure the feature flag panel](/product/sentry-toolbar/setup/#implement-feature-flag-adapter) and [what data Sentry can track](/product/explore/feature-flags/) related to your feature flagging system.


![Toolbar with the Feature Flags Panel open](./img/feature-flags-panel.png)

## Login Flow

After setting up the Sentry Toolbar you’ll see a “Login to Sentry” button floating in the center of the page. To access any information from your Sentry organization, you have to click this button and login to Sentry.
![Toolbar login button](./img/login-button.png)

After clicking the button, you will see a pop-up window for logging in to Sentry.
![Sentry log in pop up](./img/login-popup.png)

If it's your first time [setting up the Sentry Toolbar](/product/sentry-toolbar/setup) , there will be a button with a link to Sentry's Toolbar settings page to configure your domain.
![Toolbar configure domains button](./img/configure-domain.png)

Learn more about setting up the Toolbar, including configuring a feature flag provider and integrating the toolbar in different environments, on the next page.
Loading
Loading