Skip to content
Merged
Show file tree
Hide file tree
Changes from 18 commits
Commits
Show all changes
21 commits
Select commit Hold shift + click to select a range
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
15 changes: 15 additions & 0 deletions docs/product/insights/ai/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
title: "AI Performance"
sidebar_order: 135
description: "Performance views for AI developers."
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
description: "Performance views for AI developers."
description: "Learn how to use Sentry's AI Performance tool to monitor LLM calls."

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Large Language Models are just one type of AI workflow that we happen to have concentrated on first. Another example where I could imagine us having some monitoring is generative image models (as an example).

Even though the AI page is a bit sparse, my preference would be to not use monitoring LLM calls as a synonym for AI.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That makes sense. Let me take another pass at adding a bit more context here...

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about: Learn how to use Sentry's AI Performance tool to get insights into things that may be affecting your application health, including critical LLM metrics.

We can make updates here as we add new AI capabilities. Feel free to update if you have a broader way to speak to this tools without specifically mentioning LLM.

---

<Include name="feature-limited-on-team-retention.mdx" />

Sentry's [**AI Performance**](https://sentry.io/orgredirect/organizations/:orgslug/insights/ai/) page gives you an overview of the health of your application. You'll be able to see things like **Transactions Per Minute**, **p50** and **p75 Duration**, and so on.

You can also dive deeper into LLM Monitoring and get insights into critical LLM metrics, like token usage, to monitor and fix issues with AI pipelines. In addition to having a dedicated space to monitor AI performance, you can also look at Sentry's Insights tab to monitor backend, mobile, and frontend performance.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
You can also dive deeper into LLM Monitoring and get insights into critical LLM metrics, like token usage, to monitor and fix issues with AI pipelines. In addition to having a dedicated space to monitor AI performance, you can also look at Sentry's Insights tab to monitor backend, mobile, and frontend performance.
You can also dive deeper into LLM Monitoring and get insights into critical LLM metrics, like token usage, to monitor and fix issues with AI pipelines. In addition to having a dedicated space to monitor AI performance, you can also look at Sentry's **Insights** tab to monitor backend, mobile, and frontend performance.


## Learn More

<PageGrid />
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
---
title: LLM Monitoring Dashboard
sidebar_order: 100
sidebar_order: 10
description: "Learn how to use Sentry's LLM Monitoring Dashboard."
---

<Include name="feature-limited-on-team-retention.mdx" />


Once you've [configured the Sentry SDK](/product/insights/llm-monitoring/getting-started/) for your AI project, you'll start
receiving data in the Sentry LLM Monitoring dashboard.
Expand Down
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
---
title: "LLM Monitoring"
sidebar_order: 90
sidebar_order: 0
description: "Sentry LLM monitoring helps you understand your LLM calls."
---

<Include name="feature-stage-beta.mdx" />

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

Sentry's LLM Monitoring tools help you understand what's going on with your AI pipelines. They automatically collect information about prompts, tokens, and models from providers like OpenAI and Anthropic.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Cache Page"
sidebar_order: 55
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."
---

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 70
description: "Learn more about cache monitoring with Sentry and how it can help improve your application's performance."
---

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

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.

Expand Down
17 changes: 17 additions & 0 deletions docs/product/insights/backend/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Backend Performance"
sidebar_order: 45
description: "Learn how to use Sentry's Backend Performance tool to monitor things like queries, outbound API requests, caches, and queues."
---

<Include name="feature-limited-on-team-retention.mdx" />

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)

You can also dive deeper into Queries, Outbound API Requests, Caches, and Queues to get detailed information about potential issues affecting your application's health. In addition to having a dedicated space to monitor backend performance, you can also look at Sentry's **Insights** tab to monitor frontend, mobile, and AI performance.

## Learn More

<PageGrid />
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: Queries
sidebar_order: 20
sidebar_order: 0
description: "Monitor the performance of your database queries and drill into samples to investigate further."
---

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

If you have performance monitoring enabled and your application queries a database, you can see how your queries are performing in Sentry.

Expand Down Expand Up @@ -100,7 +100,7 @@ A query's source is the location in your application's code that triggered the q

You can see the query's source underneath the query description on the **Query Summary** page, as shown in the image below. If you have a [source code management integration](/organization/integrations/source-code-mgmt/) enabled, Sentry will also show a link to open the query's source in the relevant repository.

![Example of Query Source](./img/query-source-laravel.png)
![Example of Query Source](../img/query-source-laravel.png)

## Sample List

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Queues"
sidebar_order: 80
sidebar_order: 30
description: "Learn how to monitor your queues with Sentry for improved application performance and health. "
---

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

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).

Expand Down
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Queues Page"
sidebar_order: 10
sidebar_order: 20
description: "Learn how to use Sentry's Queues page to get an overview of queue performance and investigate potential problems. "
---

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

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.

Expand Down
7 changes: 7 additions & 0 deletions docs/product/insights/backend/requests.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Outbound API Requests
sidebar_order: 10
description: "Track the performance of your application's HTTP requests and drill into the domains serving those requests."
---

<Include name="insights-requests-body.mdx" />
Original file line number Diff line number Diff line change
@@ -1,14 +1,10 @@
---
title: Assets
sidebar_order: 30
sidebar_order: 20
description: "Learn more about browser asset performance monitoring, which allows you to debug the performance of loading JavaScript and CSS on your frontend."
---

<Note>
This product feature was originally named "Resources", "Assets" has the same functionality with a new name.
</Note>

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

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

Expand Down Expand Up @@ -147,7 +143,7 @@ When viewing an image asset, the asset summary page will also show the 5 largest

If size information is not available, the samples will not be ordered in any particular order. If the images are publicly accessible and the 'Enable Images' project settings is enabled, then the actual images will be rendered in the UI.

![Example of Sample Images](./img/asset-sample-images.png)
![Example of Sample Images](../img/asset-sample-images.png)

## Sample List

Expand Down
17 changes: 17 additions & 0 deletions docs/product/insights/frontend/index.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: "Frontend Performance"
sidebar_order: 10
description: "Learn how to use Sentry's Frontend Performance tool to monitor things like web vitals and network requests."
---

<Include name="feature-limited-on-team-retention.mdx" />

Sentry's Frontend Performance 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)

You can also dive deeper into Web Vitals, Network Requests, and Assets to get detailed information about potential issues affecting your application's health. In addition to having a dedicated space to monitor frontend performance, you can also look at Sentry's **Insights** tab to monitor backend, mobile, and AI performance.

## Learn More

<PageGrid />
7 changes: 7 additions & 0 deletions docs/product/insights/frontend/network-requests.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
title: Network Requests
sidebar_order: 10
description: "Track the performance of your application's HTTP requests and drill into the domains serving them."
---

<Include name="insights-requests-body.mdx" />
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
title: "Web Vitals"
sidebar_order: 60
sidebar_order: 0
description: "Understand your application's performance score and how each web vital contributes to it. Drill in to explore opportunities to improve your app's overall performance."
---

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

Web vitals are a set of metrics that measure the quality of the user experience on a web page. To learn more about these metrics, see [Web Vitals Concepts](/product/insights/web-vitals/web-vitals-concepts/).

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,14 @@ sidebar_order: 10
description: "Learn more about web vitals and how each metric relates to your application's performance."
---

<Include name="feature-limited-on-team-retention.mdx" />


[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/performance/) of your application.

The in-browser Sentry SDKs collect web vitals information (where supported) and adds that information to frontend [transactions](/product/performance/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.

![Visualization of Web Vitals](../img/diagram-transaction-vitals.png)
![Visualization of Web Vitals](../../img/diagram-transaction-vitals.png)

## Core Web Vitals

Expand All @@ -30,7 +33,7 @@ On March 12, 2024, Interaction to Next Paint (INP) replaced First Input Delay (F

[Cumulative Layout Shift (CLS)](https://web.dev/cls/) is the sum of individual layout shift scores for every unexpected element shift that happens during the rendering process. An example of this would be trying to click a link on a page that hasn't finished loading and having that link shift down before you've had a chance to click on it due to image rendering issues. The CLS web vital score isn't based on duration. It represents the extent of the disruptive and visually unstable shifts.

![Example of Cumulative Layout Shift](../img/diagram-transaction-cls.png)
![Example of Cumulative Layout Shift](../../img/diagram-transaction-cls.png)

Each layout shift score is calculated using an impact and distance fraction. The impact fraction is the total visible area that the element affects between the two rendered frames. The distance fraction measures the distance it has moved relative to the viewport.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
10 changes: 3 additions & 7 deletions docs/product/insights/index.mdx
Original file line number Diff line number Diff line change
@@ -1,16 +1,12 @@
---
title: Insights
sidebar_order: 45
description: Sentry's Insights modules provide curated views and workflows to help you identify and fix performance issues faster.
description: Sentry's Insights for frontend, backend, mobile, and AI, provide curated views and workflows to help you identify and fix issues in relevant parts of your application.
---

Sentry surfaces insights that can help you identify opportunities at the service-level to improve various parts of your app's performance, including web vitals, mobile vitals, queries, and more. Modules living under the Insights heading provide both an overview of how your project is performing in that category and the ability to drill down into traces to get to the root cause of a problem.
<Include name="feature-limited-on-team-retention.mdx" />

<Note>

These features are available for organizations on a <a href="https://sentry.io/pricing/" target="_blank">Business or Enterprise plan</a>.

</Note>
Sentry’s Insights summarize the telemetry and events tied to your projects helping you improve performance, fix bugs, and identify important trends. The views under the Insights heading provide both an overview of your project health as well as providing drill down workflows that allow you to see the underying traces, errors, and releases they summarize.

## Learn More

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 20
description: "Learn how to monitor your mobile application's performance by using App Starts to identify slow or regressed screens."
---

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

![Example of App Starts](./img/app-starts.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
---
title: "Mobile Vitals"
sidebar_order: 40
description: "Learn more about Mobile Vitals in Sentry, and how they give you a better understanding of your mobile application's health."
title: "Mobile Performance"
sidebar_order: 90
description: "Learn how to use Sentry's Mobile Performance tool to monitor the health of your mobile app, including app starts, screen loads, and screen rendering."
---

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

Mobile Vitals are a set of metrics that measure how fast your app starts and the number of slow and frozen frames your users experience. Each metric provides insights into the overall performance of your mobile application and gives you the details you need to not only prioritize critical performance issues, but to trace issues down to the root cause to solve them faster.
The [**Mobile Performance**](https://sentry.io/orgredirect/organizations/:orgslug/insights/mobile/) page gives an overview of the metrics that let you know how fast your app starts, including the number of slow and frozen frames your users may be experiencing. Each metric provides insights into the overall performance health of your mobile application. Digging into the details helps prioritize critical performance issues and allows you to identify and troubleshoot the root cause faster.

Mobile Vitals are summarized in several graphs on the **Performance** page in [sentry.io](https://sentry.io) in the "Mobile" tab.

![Performance page in Sentry with Mobile Vitals.](./img/01_full_widget_mobile.png)
![Mobile performance overview page.](../img/mobile-performance-overview.png)

## App Start

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 30
description: "Learn how to monitor your mobile application's performance by using Screen Loads to get better visibility on your application's TTID and TTFD performance."
---

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

![Example of Screen Loads](./img/screen-loads.png)

Expand Down
2 changes: 2 additions & 0 deletions docs/product/performance/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ sidebar_order: 50
description: "With performance monitoring, you can track, analyze, and debug your application's performance. Sentry helps you identify performance opportunities and trace issues back to poorly performing code."
---

<Include name="performance-moving.mdx" />

With performance monitoring, Sentry tracks application performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple services. Sentry captures [distributed traces](/product/sentry-basics/tracing/distributed-tracing/) consisting of [transactions](/product/performance/transaction-summary/#what-is-a-transaction) and spans to measure individual services and operations within those services.

<Note>
Expand Down
5 changes: 5 additions & 0 deletions includes/feature-limited-on-team-retention.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
<Note>

This view is only available on Team and Business plans. On Team plans, you won't be able to query data that's more than 7 days old. To enable querying for all your data, upgrade to the <a href="https://sentry.io/pricing/" target="_blank">Business or Enterprise plan</a>.

</Note>
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
---
title: Requests
sidebar_order: 10
description: "Track the performance of your application's HTTP requests and drill into the domains serving those requests."
---

<Include name="feature-available-for-plan-business.mdx" />
<Include name="feature-limited-on-team-retention.mdx" />

If you have performance monitoring enabled, you can track your application's HTTP requests in Sentry. Sentry monitors all outgoing HTTP requests and helps you track and investigate the domains that serve those requests.

Expand Down
6 changes: 6 additions & 0 deletions includes/performance-moving.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
<Note>

To make it easier to see what's relevant for you, Sentry's Performance landing page is now being split into separate <a href="/product/insights/frontend/" target="_blank">Frontend</a>, <a href="/product/insights/backend/" target="_blank">Backend</a>, <a href="/product/insights/mobile/" target="_blank">Mobile</a>, and
<a href="/product/insights/ai/" target="_blank">AI</a> performance pages. They can all be found in the **Insights** tab.

</Note>
62 changes: 62 additions & 0 deletions redirects.js
Original file line number Diff line number Diff line change
Expand Up @@ -798,6 +798,68 @@ const userDocsRedirects = [
'/platforms/react-native/data-management/debug-files/source-context/data-management/debug-files/upload/',
destination: '/platforms/react-native/data-management/debug-files/upload/',
},
// Redirects for prior Insights information architecture:
{
source: '/product/insights/requests/',
destination: '/product/insights/backend/requests/',
},
{
source: '/product/insights/queries/',
destination: '/product/insights/backend/queries/',
},
{
source: '/product/insights/assets/',
destination: '/product/insights/frontend/assets/',
},
{
source: '/product/insights/mobile-vitals/',
destination: '/product/insights/mobile/',
},
{
source: '/product/insights/mobile-vitals/app-starts/',
destination: '/product/insights/mobile/app-starts/',
},
{
source: '/product/insights/mobile-vitals/screen-loads/',
destination: '/product/insights/mobile/screen-loads/',
},
{
source: '/product/insights/web-vitals/',
destination: '/product/insights/frontend/web-vitals/',
},
{
source: '/product/insights/web-vitals/web-vitals-concepts/',
destination: '/product/insights/frontend/web-vitals/web-vitals-concepts/',
},
{
source: '/product/insights/caches/',
destination: '/product/insights/backend/caches/',
},
{
source: '/product/insights/caches/cache-page/',
destination: '/product/insights/backend/caches/cache-page/',
},
{
source: '/product/insights/queue-monitoring/',
destination: '/product/insights/backend/queue-monitoring/',
},
{
source: '/product/insights/queue-monitoring/queues-page/',
destination: '/product/insights/backend/queue-monitoring/queues-page/',
},
{
source: '/product/insights/llm-monitoring/',
destination: '/product/insights/ai/llm-monitoring/',
},
{
source: '/product/insights/llm-monitoring/getting-started/',
destination: '/product/insights/ai/llm-monitoring/getting-started/',
},
{
source: '/product/insights/llm-monitoring/getting-started/the-dashboard/',
destination: '/product/insights/ai/llm-monitoring/getting-started/the-dashboard/',
},
// End of Insights reduirects.
];

/**
Expand Down
Loading