Skip to content

Commit 42e3022

Browse files
author
Shannon Anahata
committed
home page and nav refresh
1 parent 8039fc2 commit 42e3022

File tree

543 files changed

+14580
-312
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

543 files changed

+14580
-312
lines changed

app/[[...path]]/page.tsx

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import {apiCategories} from 'sentry-docs/build/resolveOpenAPI';
77
import {ApiCategoryPage} from 'sentry-docs/components/apiCategoryPage';
88
import {ApiPage} from 'sentry-docs/components/apiPage';
99
import {DocPage} from 'sentry-docs/components/docPage';
10-
import {Home} from 'sentry-docs/components/home';
10+
import Home from 'sentry-docs/components/home';
1111
import {Include} from 'sentry-docs/components/include';
1212
import {PlatformContent} from 'sentry-docs/components/platformContent';
1313
import {
@@ -75,8 +75,6 @@ export default async function Page(props: {params: Promise<{path?: string[]}>})
7575
const pageNode = nodeForPath(rootNode, params.path ?? '');
7676

7777
if (!pageNode) {
78-
// eslint-disable-next-line no-console
79-
console.warn('no page node', params.path);
8078
return notFound();
8179
}
8280

@@ -111,8 +109,6 @@ export default async function Page(props: {params: Promise<{path?: string[]}>})
111109
doc = await getFileBySlugWithCache(`develop-docs/${params.path?.join('/') ?? ''}`);
112110
} catch (e) {
113111
if (e.code === 'ENOENT') {
114-
// eslint-disable-next-line no-console
115-
console.error('ENOENT', params.path);
116112
return notFound();
117113
}
118114
throw e;
@@ -149,8 +145,6 @@ export default async function Page(props: {params: Promise<{path?: string[]}>})
149145
doc = await getFileBySlugWithCache(`docs/${pageNode.path}`);
150146
} catch (e) {
151147
if (e.code === 'ENOENT') {
152-
// eslint-disable-next-line no-console
153-
console.error('ENOENT', pageNode.path);
154148
return notFound();
155149
}
156150
throw e;

app/not-found.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
import {useEffect, useState} from 'react';
44
import {Button} from '@radix-ui/themes';
55

6-
import {Header} from 'sentry-docs/components/header';
6+
import Header from 'sentry-docs/components/header';
77
import {Search} from 'sentry-docs/components/search';
88

99
export default function NotFound() {

docs/product/index.mdx

Lines changed: 10 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,12 @@
11
---
2-
title: Product Walkthroughs
3-
sidebar_order: 30
4-
description: "Sentry can be used to not just observe, but debug errors as well as identify performance issues. Check out our product walkthroughs to see it in action."
2+
title: Products
53
---
64

7-
## What's Sentry?
5+
# Products
86

9-
Sentry is a software monitoring tool that helps developers identify and debug performance issues and errors. From end-to-end distributed tracing to performance monitoring, Sentry provides code-level observability that makes it easy to diagnose issues and learn continuously about your application code health across systems and services.
7+
Welcome to the Sentry Products documentation. Here you can find detailed information about our products:
108

9+
<<<<<<< HEAD
1110
## What Can Sentry Help With?
1211

1312
As a full-stack application monitoring solution, Sentry provides the following features to help you keep your app running smoothly and your users happy:
@@ -50,7 +49,7 @@ Our [**LLM Monitoring**](/product/insights/llm-monitoring/) feature gives you in
5049

5150
### Uptime Monitoring
5251

53-
Sentry's [**Uptime Monitoring**](/product/uptime-monitoring/) helps you maintain uptime for your web services by monitoring relevant URLs. It continuously tracks configured URLs, delivering alerts and insights to quickly identify downtime and troubleshoot issues. By leveraging [distributed tracing](/product/uptime-monitoring/uptime-tracing/), Sentry enables you to pinpoint any errors that occur during an uptime check, simplifying triage and accelerating root cause analysis.
52+
Sentry's [**Uptime Monitoring**](/product/alerts/uptime-monitoring/) helps you maintain uptime for your web services by monitoring relevant URLs. It continuously tracks configured URLs, delivering alerts and insights to quickly identify downtime and troubleshoot issues. By leveraging [distributed tracing](/product/alerts/uptime-monitoring/uptime-tracing/), Sentry enables you to pinpoint any errors that occur during an uptime check, simplifying triage and accelerating root cause analysis.
5453

5554
### Recurring Job Monitoring
5655

@@ -75,3 +74,8 @@ Sentry provides many [**integrations**](/organization/integrations/) to support
7574
### SDK Support for Over 100 Platforms
7675

7776
Sentry supports over [100 platforms and frameworks](/platforms/), including 30+ coding languages, so you can track errors and performance issues no matter what your application is built on. Our SDKs have you covered so you can get started with Sentry in just a few lines of code.
77+
=======
78+
- [Sentry](/product/sentry/)
79+
- [Sentry Prevent](/product/sentry-prevent/)
80+
- [Seer](/product/seer/)
81+
>>>>>>> 74618ae7f (top nav with multi-product section and SDK section)

docs/product/issues/issue-details/sentry-seer/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,4 +67,4 @@ You can learn more about our data privacy practices [here](/security-legal-pii/
6767

6868
## Disabling Generative AI Features
6969

70-
If you don't find Seer useful and want to disable it for all users, you can do so in your organization's settings with the ["Show Generative AI Features" toggle](https://sentry.io/orgredirect/organizations/:orgslug/settings/#hideAiFeatures).
70+
If you don't find Seer useful and want to disable it for all users, you can do so in your organization's settings with the ["Enable Generative AI features" toggle](https://sentry.io/orgredirect/organizations/:orgslug/settings/#hideAiFeatures).

docs/product/seer/index.mdx

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Seer
3+
---
4+
5+
# Seer
6+
7+
This is a placeholder for Seer documentation.
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
title: Sentry Prevent
3+
---
4+
5+
# Sentry Prevent
6+
7+
This is a placeholder for Sentry Prevent documentation.
Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
---
2+
title: Alert Types
3+
sidebar_order: 10
4+
description: "Learn about the three types of alerts Sentry provides: issue alerts, metric alerts, and uptime monitoring alerts."
5+
---
6+
7+
You can create three types of alerts:
8+
9+
1. **Issue alerts**: Trigger when an issue matches a specific criteria.
10+
2. **Metric alerts**: Trigger when macro-level metrics cross specific thresholds.
11+
3. **Uptime alerts**: Trigger when an HTTP request doesn't return a successful response.
12+
13+
## Issue Alerts
14+
15+
Issue alerts trigger whenever a new event is received for any issue in a project matching the specified criteria. These criteria might be, for example, a resolved issue re-appearing or an issue affecting many users.
16+
17+
In the “Alert Rules” tab, these alerts are identified by the issues icon, and by default, they are displayed at the bottom of your list of alerts. (If you have several metric alerts, this may push your issue alerts off the first page of the list.)
18+
19+
![Issue alert rules at the bottom of the list of alerts.](./img/issue-alert-rules.png)
20+
21+
In issue alerts, Sentry evaluates the configured alert conditions each time it receives a new event. Alert conditions have three parts:
22+
23+
1. [Triggers](/product/alerts/create-alerts/issue-alert-config/#when-conditions-triggers) specify what type of activity you'd like monitored, or **When** an alert should be triggered.
24+
2. [Filters](/product/alerts/create-alerts/issue-alert-config/#if-conditions-filters) help control noise by triggering an alert only **If** the issue matches the specified criteria.
25+
3. **Then**, [Actions](/product/alerts/create-alerts/issue-alert-config/#then-conditions-actions) specify what should happen when the trigger conditions are met and the filters match.
26+
27+
### Alert Details
28+
29+
The **Alert Details** page shows you the number of times an issue alert rule was triggered over time, grouped in one hour buckets. Clicking on the alert rule name in the "Alert Rules" tab, or on the notification you receive will take you to this page. The page also includes the alert rule conditions, the current status of the alert (Warning, Critical, or Resolved), and alert details such as when it was created, when it was last modified, and the team that owns the alert.
30+
31+
![Alert details illustrates a graph showing the alerts triggered over time.](./img/issue-alert-status-page-example.png)
32+
33+
The **Alert Details** page also includes a list of issues that triggered the alert. You can click on any of the issues in the list to go to that issue's details page for more information.
34+
35+
## Metric Alerts
36+
37+
<Include name="feature-available-for-plan-team.mdx" />
38+
39+
Metric alerts tell you when a [metric](/product/insights/overview/metrics/) crosses a threshold set by you, like a spike in the number of errors in a project, or a change in a performance metric, such as [transaction duration](/product/insights/overview/metrics/#latency), [Apdex](/product/insights/overview/metrics/#apdex), [failure rate](/product/insights/overview/metrics/#failure-rate), or [throughput](/product/insights/overview/metrics/#throughput-total-tpm-tps). You can use [dynamic alerts](/product/alerts/create-alerts/metric-alert-config/#dynamic-alerts) to let Sentry define the threshold for you.
40+
41+
Metric alerts monitor macro-level metrics for both error and transaction events. A metric takes a set of events and computes an aggregate value using a function, such as `count()` or `avg()`, applied to the event properties over a period of time. When you create a metric alert, you can filter events by attributes and <PlatformLink to="/enriching-events/tags/">tags</PlatformLink>, which is particularly useful for aggregating across events that aren't grouped into single issues. Sentry allows a maximum of 1000 metric alerts for an organization.
42+
43+
<Alert>
44+
45+
Metric alerts may include [archived issues](/product/issues/states-triage/#archive) if events from those issues match the filters of your metric alert rule. Events from archived and resolved issues can be filtered out by using the `is:unresolved` filter in your metric alert rule. This filter is added by default when creating a new metric alert, but you may need to manually add it to older metric alerts if you want them to exclude archived issues.
46+
47+
</Alert>
48+
49+
These alerts use _Critical_ and _Warning_ triggers to measure severity. An alert’s current status is the highest severity trigger that is active, which can be one of three values: Warning, Critical, or Resolved. Sentry notifies you whenever an alert's status changes.
50+
51+
When you create an alert, all the displayed alert types (except “Issues”) may be used to create a metric alert. You can create metric alerts for Errors, Sessions (Crash Rate Alerts), and Performance:
52+
53+
### Errors
54+
55+
Error alerts are useful for monitoring the overall level of errors in your project, errors occurring in specific parts of your app, or errors affecting your users.
56+
57+
- **Number of Errors:** <a name="number-of-errors"></a>
58+
Alerts when the number of errors in a project matching your filters crosses the threshold you set.
59+
60+
- **Users Experiencing Errors:** <a name="users-experiencing-errors"></a>
61+
Alerts when the number of users affected by errors in your project crosses the threshold you set.
62+
63+
### Sessions (Crash Rate Alerts)
64+
65+
Crash rate alerts can give you a better picture of the health of your app on a per project basis or in a specific release. They trigger when the crash-free percentage for either [sessions or users](/product/releases/health/#active-sessionsusers) falls below a specific threshold. This could happen because of a spike in the number of session or user [crashes](/product/releases/health/#crash).
66+
67+
- **Crash Free Session Rate:** <a name="crash-free-session-rate"></a>
68+
Alerts when the number of crashed sessions exceeds the threshold you set. A session begins when a user starts the application and ends when it’s closed or sent to the background. A crash is when a session ends due to an error.
69+
70+
- **Crash Free User Rate:** <a name="crash-free-user-rate"></a>
71+
Alerts when the overall user experience dips below the threshold you set. Crash Free Users represents the percentage of individual users who haven’t experienced a crash.
72+
73+
### Performance
74+
75+
Application performance alerts can help you pinpoint and identify specific problems that may be causing a suboptimal experience for your users.
76+
77+
- **Throughput:** <a name="throughput"></a>
78+
Alerts when throughput (the total number of transactions in a project) reaches a threshold set by you within a specified period of time.
79+
80+
- **Transaction Duration:** <a name="transaction-duration"></a>
81+
Alerts when transaction durations meet certain conditions.
82+
83+
**TIP:** The conditions can be customized with flexible aggregates like percentiles, averages, and min/max.
84+
85+
- **Apdex:** <a name="apdex"></a>
86+
Alerts on the Apdex score (the ratio of satisfactory, tolerable, and frustrated requests in a specific transaction or endpoint). Apdex is a metric used to track and measure user satisfaction based on your application response times.
87+
88+
- **Failure Rate:** <a name="failure-rate"></a>
89+
Alerts on failure rate (the percentage of unsuccessful transactions). Sentry treats transactions with a status other than “ok,” “canceled,” and “unknown” as failures.
90+
91+
- **Largest Contentful Display:** <a name="largest-contentful-display"></a>
92+
Alerts when the Largest Contentful Paint (LCP), which measures loading performance, is loading slower than expected. LCP marks the point when the largest image or text block is visible within the viewport.
93+
94+
**TIP:** A fast LCP helps reassure the user that the page is useful. We recommend an LCP of less than 2.5 seconds.
95+
96+
- **First Input Delay:** <a name="first-input-delay"></a>
97+
Alerts when First Input Delay (FID), which measures the response time when a user tries to interact with the viewport, is longer than expected.
98+
99+
**TIP:** A low FID helps ensure that a page is useful. We recommend a FID of less than 100 milliseconds.
100+
101+
- **Cumulative Layout Shift:** <a name="cumulative-layout-shift"></a>
102+
Alerts when cumulative Layout Shift (CLS), which measures visual stability by quantifying unexpected layout shifts that occur during the entire lifespan of the page, increases.
103+
104+
**TIP:** A CLS of less than 0.1 translates to a good user experience, while anything greater than 0.25 is poor.
105+
106+
- **Custom Metric:** <a name="custom-metric"></a>
107+
Alerts on metrics which are not listed above, such as first paint (FP), first contentful paint (FCP) and time to first byte (TTFB).
108+
109+
### Alert Details
110+
111+
The **Alert Details** page shows you the history of a metric alert rule for the last 24 hours by default, though can modify the time period using the "Display" dropdown. When an alert is triggered, clicking the notification you receive takes you to this page, which displays the period when the alert was active. The page also includes details such as the alert rule conditions, the current status of the alert, and a summary of how much time the alert spent in each state (Critical, Warning, or Resolved).
112+
113+
![Alert details illustrates a graph showing the performance of a transaction over time.](./img/alert-details-example.png)
114+
115+
The **Alert Details** page also includes a list of suspect issues or transactions related to the metric, to help pinpoint the root problem more quickly. You can see what might have caused the alert to be triggered, and then open the metric in **[Discover](/product/explore/discover-queries)** to find more information.
116+
117+
## Uptime Alerts
118+
119+
Uptime alerts trigger whenever an uptime check request fails to meet our [uptime check criteria](/product/alerts/uptime-monitoring/#uptime-check-criteria). You'll be able to see the latest uptime check request status ("Up" or "Down") in the “Alert Rules” tab.
120+
121+
### Alert Details
122+
123+
The **Alert Details** page provides a timeline of uptime check events associated with the alert. This timeline allows you to track when and where failures occurred. Selecting a section of the timeline automatically updates the date range filter, enabling you to browse historical uptime check data.
124+
125+
The **Alert Details** page also includes a list of [uptime issues](/product/issues/issue-details/uptime-issues) that were created by the alert when uptime failures are detected. Clicking on any of the issues will take you to a page with additional information that may help you debug that issue.
126+
127+
## User Feedback Alerts
128+
129+
You can enable alerts for the [User Feedback Widget](/product/user-feedback/#user-feedback-widget) on the [issue alerts](https://sentry.io/orgredirect/organizations/:orgslug/alerts/new/issue/) page by following the steps below:
130+
131+
1. Create a [New Alert Rule](https://sentry.io/orgredirect/organizations/:orgslug/alerts/new/issue/) in Sentry.
132+
2. Scroll to the "Set conditions" section and set the "IF" filter to `The issue's category is equal to… "Feedback"`.
133+
3. Choose which actions to perform in the “THEN” filter.
134+
4. Add an alert name and owner.
135+
136+
![User Feedback Alert Configuration.](../user-feedback/img/user-feedback-alert-configuration.png)
137+
138+
To get alerts when [crash-report feedback](/product/user-feedback/#crash-report-modal) comes in, make sure to turn on "Enable Crash Report Notifications" in Settings > Projects > [Project Name] > User Feedback.

0 commit comments

Comments
 (0)