Skip to content
Open
Show file tree
Hide file tree
Changes from all 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
8 changes: 7 additions & 1 deletion docs/product/insights/backend/caches/cache-page.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,15 @@ sidebar_order: 30
description: "Learn more about Sentry's Cache page, which provides insights into cache utilization and latency, so you can investigate potential cache performance issues."
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

The **Caches** page gives an overview of cache performance across all endpoints for currently selected backend projects with summary graphs for **Miss Rate** and **Requests Per Minute** (throughput). You can use these as a starting point to see if there are any potential cache performance issues, for example, a higher than expected Miss Rate percentage.

If you see an anomaly or want to investigate a time range further, click and drag to select a range directly in the graph and data will be filtered for that specific time range only.
If you see an anomaly or want to investigate a time range further, click and drag to select a range directly in the graph and data will be filtered for that specific time range only.

The transaction table shows a list of endpoints that contain at least one `cache.get` span along with:

Expand Down
6 changes: 6 additions & 0 deletions docs/product/insights/backend/caches/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ sidebar_order: 70
description: "Learn more about cache monitoring with Sentry and how it can help improve your application's performance."
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

A cache can be used to speed up data retrieval, thereby improving application performance. A cache stores data temporarily to speed up subsequent access to that data. This allows your application to get data from cached memory (if it is available) instead having to download that data again or retrieving it from a potentially slow data layer. Caching can speed up read-heavy workloads for applications like Q&A portals, gaming, media sharing, and social networking.

A successful cache results in a high hit rate which means the data was present when fetched. A cache miss occurs when the data fetched was not present in the cache. If you have performance monitoring enabled and your application uses caching, you can see how your caches are performing with Sentry.
Expand Down
6 changes: 6 additions & 0 deletions docs/product/insights/backend/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ description: >-
og_image: /og-images/product-insights-backend.png
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

Sentry's [**Backend Performance**](https://sentry.io/orgredirect/organizations/:orgslug/insights/backend/) page gives you an overview of the health of your application. You'll be able to see things like the **Most Time-Consuming Queries**, **Most Time-Consuming Domains**, **p50** and **p75 Duration**, and so on.

![Backend performance overview page.](../img/backend-performance-overview.png)
Expand Down
6 changes: 6 additions & 0 deletions docs/product/insights/backend/queries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ description: >-
og_image: /og-images/product-insights-backend-queries.png
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

If you have [Insights](/product/insights/) enabled and your application queries a database, you can see how your queries are performing in Sentry.

Sentry's query monitoring helps you investigate the performance of your queries and get more information to improve them.
Expand Down
6 changes: 6 additions & 0 deletions docs/product/insights/backend/queue-monitoring/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ sidebar_order: 30
description: "Learn how to monitor your queues with Sentry for improved application performance and health. "
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

Message Queues make asynchronous service-to-service communication possible in distributed architectures. Queues are great for making work that sometimes fails, more resilient and are therefore a building block for distributed applications. Some examples of what queues can help with include handling webhooks from third-party APIs or handling periodic tasks (such as calculating metrics for your users daily).

If you have performance monitoring enabled and your application interacts with message queue systems, you can configure Sentry to monitor their performance and health.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ sidebar_order: 20
description: "Learn how to use Sentry's Queues page to get an overview of queue performance and investigate potential problems. "
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

The **Queues** page provides a breakdown of queue performance by destination (the topic name or queue name). Use it as a starting point to investigate potential problems with queues, such as higher than expected processing latency.

A the top of the page, the Average Latency graph shows the total time that messages take to complete. The Published versus Processed graph shows how many messages are being written to the queue versus how many are being completed. If you see an anomaly or want to investigate a time range further, click and drag to select a range directly in the graph and you'll see data for that specific time range only.
Expand Down
6 changes: 6 additions & 0 deletions docs/product/insights/backend/requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,10 @@ sidebar_order: 10
description: "Track the performance of your application's HTTP requests and drill into the domains serving those requests."
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

<Include name="insights-requests-body.mdx" />
9 changes: 7 additions & 2 deletions docs/product/insights/frontend/assets.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ description: >-
og_image: /og-images/product-insights-frontend-assets.png
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

If you have performance monitoring enabled for your frontend, you can see how your browser assets are performing in Sentry.

Starting with the [**Assets** page](#assets-page), you get a high-level overview of how your assets are doing. From there, you can drill into a specific asset's [**Asset Summary** page](#asset-summary-page) and then investigate sample events from the [Sample List](#sample-list) to better understand the context of its performance in a specific page.
Expand Down Expand Up @@ -75,6 +81,7 @@ resources.forEach((entry) => {
span.finish(startTime + duration);
});
```

## Assets Page

The **Assets** page gives you a quick overview of your application's asset performance for the selected project(s). You can use this page as a starting point to investigate potential problem assets and drill down to better understand how various assets are affecting your app's performance.
Expand All @@ -93,7 +100,6 @@ You can also filter assets by domain, type, page it's found on, and whether it h

To view more details, click on a asset from the table to open its **Asset Summary** page.


### What Does a Render Blocking Mean?

A render blocking asset is one which will stop the browser from rendering anything on the screen, until the asset is fully download and processed by the browser.
Expand Down Expand Up @@ -137,7 +143,6 @@ At the bottom, you can find a list of pages the asset is found in, sorted by the

If you want to investigate a specific page, click on it to open a sidebar showing some sample events.


### Image Samples

When viewing an image asset, the asset summary page will also show the 5 largest image samples. Sentry determines the span is an image if it has one of the following extensions: 'jpg', 'jpeg', 'png', 'gif', 'svg', 'webp', 'apng', 'avif'.
Expand Down
6 changes: 6 additions & 0 deletions docs/product/insights/frontend/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ description: >-
og_image: /og-images/product-insights-frontend.png
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

Sentry's [**Frontend Performance**](https://sentry.io/orgredirect/organizations/:orgslug/insights/frontend/) page gives you an overview of the health of your application. You'll be able to see things like **Best Page Opportunities** (the improvements that would most help increase your performance score), your **Most Time-Consuming Assets**, **p50** and **p75 Duration**, and so on.

![Frontend performance overview page.](../img/frontend-performance-overview.png)
Expand Down
6 changes: 6 additions & 0 deletions docs/product/insights/frontend/network-requests.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,10 @@ sidebar_order: 10
description: "Track the performance of your application's HTTP requests and drill into the domains serving them."
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

<Include name="insights-requests-body.mdx" />
6 changes: 6 additions & 0 deletions docs/product/insights/frontend/session-health.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ sidebar_order: 30
description: "Get insights about your application's session health over time."
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

<Include name="insights-session-health-body.mdx" />

<Include name="insights-session-health-frontend.mdx" />
8 changes: 7 additions & 1 deletion docs/product/insights/frontend/web-vitals/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,12 @@ sidebar_order: 0
description: "Get a clear picture of your app's Performance Score and how each Web Vital shapes it. Then, learn how to drill in to explore opportunities to improve your app's overall performance."
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

Web vitals are a set of key metrics that measure how users actually experience your site; these include load speed, responsiveness and visual stability. [Learn more about these metrics in Web Vitals Concepts](/product/insights/web-vitals/web-vitals-concepts/).

For your instrumented web apps, Sentry gathers Web Vitals from real user traffic across [supported browsers](web-vitals-concepts/#browser-support). These metrics are used to calculate a [Performance Score](#performance-score) for your web application. Using these metrics, we surface the pages that have the most [opportunity](#opportunity) to improve your app's overall performance.
Expand Down Expand Up @@ -95,5 +101,5 @@ You can find out how to set up Sentry on your web application in the [installati
Although Sentry provides auto instrumentation for many frontend frameworks, there are some environments and scenarios that may not be fully supported. If you are unable to find your pages in the **Web Vitals** page, check to see if your page loads are meeting the following conditions:

- **Performance Scores** only support **Chrome**, **Firefox**, **Safari**, **Opera**, and **Edge** desktop and mobile browsers.
- Some pageloads may not capture all Web Vitals supported by Sentry. This may depend on the client browser and/or the unique behavior of your web page.
- Some pageloads may not capture all Web Vitals supported by Sentry. This may depend on the client browser and/or the unique behavior of your web page.
- Find out the full list of Web Vitals in the [Browser Support](/product/insights/web-vitals/web-vitals-concepts/#browser-support) table.
41 changes: 28 additions & 13 deletions docs/product/insights/frontend/web-vitals/web-vitals-concepts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ description: >-
og_image: /og-images/product-insights-frontend-web-vitals-web-vitals-concepts.png
---

<Alert level="warning">

Insights is going away soon. You can find all the same insights over in [Sentry Dashboards](/product/dashboards/sentry-dashboards).

</Alert>

[Web Vitals](https://web.dev/vitals/) are a set of metrics defined by Google to measure render time, response time, and layout shift. Each data point provides insights about the overall [performance](/product/insights/overview/) of your application.

The in-browser Sentry SDKs collect web vitals information (where supported) and adds that information to frontend [transactions](/product/insights/overview/transaction-summary/). These web vitals are then summarized in the [**Performance > Web Vitals** page](/product/insights/web-vitals/) to give you a quick overview of how each page is performing for your users.
Expand All @@ -24,7 +30,14 @@ Google considers Core Web Vitals to be the most important metrics for measuring
### Interaction to Next Paint (INP)

<Alert>
On March 12, 2024, Interaction to Next Paint (INP) replaced First Input Delay (FID) as a Core Web Vital. Prior to this, INP was an experimental metric that Sentry did not collect. To begin collecting INP measurements, make sure your JavaScript SDK version is [7.104.0](https://github.com/getsentry/sentry-javascript/releases/tag/7.104.0) or higher and that the option [`enableInp`](/platforms/javascript/tracing/instrumentation/automatic-instrumentation/#enableinp) is on (starting with version `8.0.0`, `enableInp` is enabled by default).
On March 12, 2024, Interaction to Next Paint (INP) replaced First Input Delay
(FID) as a Core Web Vital. Prior to this, INP was an experimental metric that
Sentry did not collect. To begin collecting INP measurements, make sure your
JavaScript SDK version is
[7.104.0](https://github.com/getsentry/sentry-javascript/releases/tag/7.104.0)
or higher and that the option
[`enableInp`](/platforms/javascript/tracing/instrumentation/automatic-instrumentation/#enableinp)
is on (starting with version `8.0.0`, `enableInp` is enabled by default).
</Alert>

[Interaction to Next Paint (INP)](https://web.dev/articles/inp) measures the time from when a user interacts with a page (through a click, tap, or keyboard input) to when the next paint (rendering of content on the screen) occurs. INP aims to assess how quickly users see a response from the website after taking an action, which is crucial for providing a smooth and responsive user experience.
Expand Down Expand Up @@ -62,33 +75,35 @@ First Paint (FP) measures the amount of time the first pixel takes to appear in
### First Input Delay (FID)

<Alert>
As of March 12, 2024, First Input Delay (FID) was replaced as a Core Web Vital by INP. While Sentry no longer includes FID in our performance score calculations nor on the **Web Vitals** performance page, we continue to collect FID metrics. You can query FID measurements in [Discover](/product/explore/discover-queries/).
As of March 12, 2024, First Input Delay (FID) was replaced as a Core Web Vital
by INP. While Sentry no longer includes FID in our performance score
calculations nor on the **Web Vitals** performance page, we continue to
collect FID metrics. You can query FID measurements in
[Discover](/product/explore/discover-queries/).
</Alert>

[First Input Delay (FID)](https://web.dev/fid/) measures response time when a user tries to interact with the viewport by clicking a button, link, or any other custom JavaScript controller. FID data is critical for understanding whether interactions on an application page are successful or not.


## Thresholds

Google's "Good", "Needs Improvement", and "Poor" thresholds are used to classify data points into green, yellow, and red for the corresponding Web Vitals. "Needs improvement" is referred to as "Meh" in Sentry.

| Web Vital | Good | Meh | Poor |
| --------------------------------------------------------------- | -------- | -------- | ------- |
| [Largest Contentful Paint](#largest-contentful-paint-lcp) (LCP) | &lt;= 2.5s | &lt;= 4s | > 4s |
| [Interaction to Next Paint](#interaction-to-next-paint-inp) (INP)| &lt;= 200ms | &lt;= 500ms | > 500ms |
| [Cumulative Layout Shift](#cumulative-layout-shift-cls) (CLS) | &lt;= 0.1 | &lt;= 0.25 | > 0.25 |
| [First Paint](#first-paint-fp) (FP) | &lt;= 1s | &lt;= 3s | > 3s |
| [First Contentful Paint](#first-contentful-paint-fcp) (FCP) | &lt;= 1s | &lt;= 3s | > 3s |
| [Time To First Byte](#time-to-first-byte-ttfb) (TTFB) | &lt;= 100ms | &lt;= 200ms | > 600ms |
| [First Input Delay](#first-input-delay-fid) (FID) | &lt;= 100ms | &lt;= 300ms | > 300ms |
| Web Vital | Good | Meh | Poor |
| ----------------------------------------------------------------- | ----------- | ----------- | ------- |
| [Largest Contentful Paint](#largest-contentful-paint-lcp) (LCP) | &lt;= 2.5s | &lt;= 4s | > 4s |
| [Interaction to Next Paint](#interaction-to-next-paint-inp) (INP) | &lt;= 200ms | &lt;= 500ms | > 500ms |
| [Cumulative Layout Shift](#cumulative-layout-shift-cls) (CLS) | &lt;= 0.1 | &lt;= 0.25 | > 0.25 |
| [First Paint](#first-paint-fp) (FP) | &lt;= 1s | &lt;= 3s | > 3s |
| [First Contentful Paint](#first-contentful-paint-fcp) (FCP) | &lt;= 1s | &lt;= 3s | > 3s |
| [Time To First Byte](#time-to-first-byte-ttfb) (TTFB) | &lt;= 100ms | &lt;= 200ms | > 600ms |
| [First Input Delay](#first-input-delay-fid) (FID) | &lt;= 100ms | &lt;= 300ms | > 300ms |

<Alert>

Some Web Vitals such as FP, FCP, LCP, and TTFB are measured relative to the start of the transaction. Values may differ when compared to values generated with other tools such as [Lighthouse](https://github.com/GoogleChrome/lighthouse).

</Alert>


## Browser Support

Not all browsers fully support all web vitals. Sentry uses available web vitals to calculate [Performance Score](/product/insights/web-vitals/#performance-score).
Expand Down
Loading
Loading