Skip to content

ref(insights): move performance docs under insights #12720

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 12 commits into from
Feb 25, 2025
Merged
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
2 changes: 1 addition & 1 deletion .github/CODEOWNERS
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
# /src/wizard/rust/ @getsentry/owners-native

# /src/docs/product/discover-queries/ @getsentry/visibility
# /src/docs/product/performance/ @getsentry/visibility
# /src/docs/product/insights/ @getsentry/insights

# /src/docs/cli/dif.mdx @getsentry/owners-native

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ sidebar_order: 20

You'll find numerous references to both `sentry` and `getsentry` in our documentation. Both are [Django](https://www.djangoproject.com/) apps, but `sentry` [is open](https://github.com/getsentry/sentry) and `getsentry` is closed. What's in which?

The main thing to emphasize is that all of our product features—[Issues](https://docs.sentry.io/product/issues/), [Performance](https://docs.sentry.io/product/performance/), [Dashboards](https://docs.sentry.io/product/dashboards/), and [such](https://docs.sentry.io/product/)—are implemented and available in `sentry`, the open component. It's really important to us that we're not an "open core" company that hides key functionality behind a paywall. [Sentry is as open-source as we can make it](https://open.sentry.io/licensing/).
The main thing to emphasize is that all of our product features—[Issues](https://docs.sentry.io/product/issues/), [Insights](https://docs.sentry.io/product/insights/), [Dashboards](https://docs.sentry.io/product/dashboards/), and [such](https://docs.sentry.io/product/)—are implemented and available in `sentry`, the open component. It's really important to us that we're not an "open core" company that hides key functionality behind a paywall. [Sentry is as open-source as we can make it](https://open.sentry.io/licensing/).

So what's in `getsentry`, then? It implements billing and account management features for [our SaaS, sentry.io](https://sentry.io/). `getsentry` is the Django app we deploy to production. It imports the `sentry` Django app, adds some routes and models, and re-exports it.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ In terms of technical implementation, it is similar to [Data Scrubbing](/backend

## The Problem

In our [Performance](https://docs.sentry.io/product/performance/) product, transactions are grouped by their name
In our [Insights](https://docs.sentry.io/product/insights/overview/) product, transactions are grouped by their name
(the [`event.transaction`](/sdk/data-model/event-payloads/#optional-attributes) field).
This works well as long as the cardinality of distinct transaction names that the SDK sends is low, for example
by using the [route of a web framework](https://docs.sentry.io/platforms/javascript/guides/react/configuration/integrations/react-router/) as the transaction name.
Expand All @@ -22,7 +22,7 @@ and it falls back to the raw URL (or rather,
[its path component](https://en.wikipedia.org/wiki/Uniform_Resource_Identifier#Syntax)).

This makes it harder for the user to extract insights from [Performance
metrics](https://docs.sentry.io/product/performance/metrics/), because instead of presenting averages, percentiles and distributions of groups of transactions that logically
metrics](https://docs.sentry.io/product/insights/overview/metrics/), because instead of presenting averages, percentiles and distributions of groups of transactions that logically
belong together, we end up with a bunch of one-off transaction groups.

```URLs
Expand Down
2 changes: 1 addition & 1 deletion develop-docs/sdk/telemetry/traces/opentelemetry.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This page is under active development. Specifications are not final and subject

</Alert>

This document details Sentry's work in integrating and supporting [OpenTelemetry](https://opentelemetry.io/), the open standard for metrics, traces and logs. In particular, it focuses on the integration between [Sentry's performance monitoring product](https://docs.sentry.io/product/performance/) and [OpenTelemetry's tracing spec](https://opentelemetry.io/docs/concepts/signals/traces/).
This document details Sentry's work in integrating and supporting [OpenTelemetry](https://opentelemetry.io/), the open standard for metrics, traces and logs. In particular, it focuses on the integration between [Sentry's performance monitoring product](https://docs.sentry.io/product/insights/overview/) and [OpenTelemetry's tracing spec](https://opentelemetry.io/docs/concepts/signals/traces/).

## Background

Expand Down
2 changes: 1 addition & 1 deletion develop-docs/self-hosted/experimental/errors-only.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ This is our default version of self-hosted Sentry. It includes most of the featu
3. [Replays](https://docs.sentry.io/product/explore/session-replay/)
4. [Insights](https://docs.sentry.io/product/insights/) (Requests, Queries, Assets, etc)
5. [User Feedback](https://docs.sentry.io/product/user-feedback/)
6. [Performance](https://docs.sentry.io/product/performance/)
6. [Insights](https://docs.sentry.io/product/insights/)
7. [Crons](https://docs.sentry.io/product/crons/)
8. [Metrics](https://docs.sentry.io/product/explore/metrics/)

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/key-terms/key-terms.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Each of these key features have their own page (or set of pages) in the [sentry.

- **Insights** - Sentry surfaces insights that can help you identify opportunities at the service-level to improve various parts of your app's performance, including requests, assets, caches, queues, and more. Modules living under the Insights heading provide an overview of how your project is performing in that category, as well as the ability to review sample events and their traces to help you diagnose potential problems.

- **Performance** - The main view in [sentry.io](http://sentry.io) where you can search or browse for transaction data. The page displays graphs that visualize transactions or trends, as well as a table where you can view relevant transactions and drill down to more information about them. Learn more in the full [performance monitoring documentation](/product/performance/).
- **Insights Overview** - The main view in [sentry.io](http://sentry.io) where you can search or browse for transaction data. The page displays graphs that visualize transactions or trends, as well as a table where you can view relevant transactions and drill down to more information about them. Learn more in the full [performance monitoring documentation](/product/insights/overview/).

- **Alerts** - Where you can create new alert rules and manage existing ones. Learn more in the full [Alerts documentation](/product/alerts/).

Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/key-terms/tracing/distributed-tracing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 10
description: With distributed tracing, you can track software performance and measure throughput & latency, while seeing the impact of errors across multiple systems.
---

Distributed tracing provides a connected view of your application from frontend to backend. It helps track software performance, measure [metrics](/product/performance/metrics/) like throughput and latency, and display the impact of errors across multiple systems. This makes Sentry a more complete [performance monitoring](/product/performance/) solution, aiding in diagnosing problems and measuring your application's overall health.
Distributed tracing provides a connected view of your application from frontend to backend. It helps track software performance, measure [metrics](/product/insights/overview/metrics/) like throughput and latency, and display the impact of errors across multiple systems. This makes Sentry a more complete [performance monitoring](/product/insights/overview/) solution, aiding in diagnosing problems and measuring your application's overall health.

[Tracing](/concepts/key-terms/tracing/distributed-tracing/) in Sentry provides insights such as:

Expand Down Expand Up @@ -76,7 +76,7 @@ Distributed tracing allows you to follow a request from the [frontend](/product/

A **trace** represents the record of the entire operation you want to measure or track, like page load or a user action. When a trace includes work in multiple services, it's called a **distributed trace**.

Each trace consists of one or more tree-like structures called [**transactions**](/product/performance/transaction-summary/), with nodes called **spans**. Each transaction represents a single instance of a service being called, and each span represents a single unit of work. Here's an example trace, broken down into transactions and spans:
Each trace consists of one or more tree-like structures called [**transactions**](/product/insights/overview/transaction-summary/), with nodes called **spans**. Each transaction represents a single instance of a service being called, and each span represents a single unit of work. Here's an example trace, broken down into transactions and spans:

![Diagram illustrating how a trace is composed of multiple transactions, and each transaction is composed of multiple spans.](./img/diagram-transaction-trace.png)

Expand Down Expand Up @@ -227,4 +227,4 @@ Dynamic sampling ensures complete traces by retaining all transactions associate

Use the [Trace Explorer](/product/explore/traces/) to search for traces containing spans that meet your specific query conditions. This helps you find distributed traces that give you a connected view of your application and can help you debug and optimize your code.

Through [Performance](/product/performance/) and [Discover](/product/explore/discover-queries/), you can also view trace data in the [Trace View](/concepts/key-terms/tracing/trace-view/) page.
Through [Performance](/product/insights/overview/) and [Discover](/product/explore/discover-queries/), you can also view trace data in the [Trace View](/concepts/key-terms/tracing/trace-view/) page.
2 changes: 1 addition & 1 deletion docs/concepts/search/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Here are some examples of valid comparison operator searches:

<Alert>

`OR` and `AND` search conditions are only available for [Discover](/product/explore/discover-queries/), [Performance](/product/performance/), and [Metric Alerts](/product/alerts-notifications/metric-alerts/).
`OR` and `AND` search conditions are only available for [Discover](/product/explore/discover-queries/), [Insights Overview](/product/insights/overview/), and [Metric Alerts](/product/alerts-notifications/metric-alerts/).

</Alert>

Expand Down
6 changes: 3 additions & 3 deletions docs/concepts/search/searchable-properties/events.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ Below is a list of keys and tokens that can be used in the event search.

### `apdex(threshold)`

Returns results with the [Apdex score](/product/performance/metrics/#apdex) that you entered. Values must be between `0` and `1`. Higher apdex values indicate higher user satisfaction.
Returns results with the [Apdex score](/product/insights/overview/metrics/#apdex) that you entered. Values must be between `0` and `1`. Higher apdex values indicate higher user satisfaction.

- **Type:** number

Expand Down Expand Up @@ -685,7 +685,7 @@ Span ID of the root span of the root transaction in the event.

### `transaction`

For [transactions](/product/performance/transaction-summary/#what-is-a-transaction), the name of the transaction. For errors, the name of the associated transaction.
For [transactions](/product/insights/overview/transaction-summary/#what-is-a-transaction), the name of the transaction. For errors, the name of the associated transaction.

- **Type:** string

Expand Down Expand Up @@ -715,7 +715,7 @@ The [Unreal Crash Context Type](https://docs.unrealengine.com/4.27/en-US/API/Run

### `user_misery(number)`

Returns transactions with the defined user misery value. [User Misery](/product/performance/metrics/#user-misery) is a user-weighted performance metric that counts the number of unique users who were frustrated; "frustration" is measured as a response time four times the satisfactory response time threshold (in milliseconds). It highlights transactions that have the highest impact on users.
Returns transactions with the defined user misery value. [User Misery](/product/insights/overview/metrics/#user-misery) is a user-weighted performance metric that counts the number of unique users who were frustrated; "frustration" is measured as a response time four times the satisfactory response time threshold (in milliseconds). It highlights transactions that have the highest impact on users.

- **Type:** number

Expand Down
2 changes: 1 addition & 1 deletion docs/concepts/search/searchable-properties/issues.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -426,7 +426,7 @@ A trace represents the record of the entire operation you want to measure or tra

### `transaction`

For [transactions](/product/performance/transaction-summary/#what-is-a-transaction), the name of the transaction. For errors, the name of the associated transaction.
For [transactions](/product/insights/overview/transaction-summary/#what-is-a-transaction), the name of the transaction. For errors, the name of the associated transaction.

- **Type:** string

Expand Down
4 changes: 2 additions & 2 deletions docs/contributing/approach/product-docs/write-index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -41,12 +41,12 @@ Use this approach for a feature that doesn’t require much explanation and has

## How: Wider-Ranging Features - Benefit Breakdown

Use this approach for a page that requires more explanation to break down and/or has a lot of child pages to explain its different benefits, like [Performance monitoring](/product/performance/).
Use this approach for a page that requires more explanation to break down and/or has a lot of child pages to explain its different benefits, like [Insights](/product/insights/).

- Describe how each page section/element or child page, helps the customer achieve the WHY of this feature.
- Include links to relevant child pages in the text.
- Group page sections/elements or child pages as appropriate. {/*<!-- TO DO add an example here - probably the new Alerts index page -->*/}
- Add headings that describe the benefit rather than the page section/element like [here](/product/performance/#analyze-performance-trends).
- Add headings that describe the benefit rather than the page section/element like [here](/product/insights/overview/#analyze-performance-trends).
- Describe how this feature fits in/interacts with other parts of the application, if applicable (e.g., this page has a button that takes you Discover queries).

If you use this approach, you may want to include a very high-level, one- or two-sentence description of what the page looks like as part of the WHAT/WHY section.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ Add the configuration code sample to this directory:

<Alert>

If the SDK supports performance monitoring, add it to the list that links back into the SDK content from Product, stored in [`/docs/product/performance/getting-started.mdx`](https://github.com/getsentry/sentry-docs/blob/master/docs/product/performance/getting-started.mdx).
If the SDK supports performance monitoring, add it to the list that links back into the SDK content from Product, stored in [`/docs/product/insights/getting-started.mdx`](https://github.com/getsentry/sentry-docs/blob/master/docs/product/insights/getting-started.mdx).

</Alert>

Expand Down
2 changes: 1 addition & 1 deletion docs/organization/early-adopter-features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ Limitations:

- [Issue Views](/product/issues/issue-views/)
- [Issue Status](/product/issues/states-triage/) tags
- [Span Summary](/product/performance/transaction-summary/#span-summary)
- [Span Summary](/product/insights/overview/transaction-summary/#span-summary)
- [Dynamic Alerts](/product/alerts/create-alerts/metric-alert-config/#dynamic-alerts)
- [New Trace Explorer With Span Metrics](/product/explore/new-trace-explorer/)
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Transaction Name
description: "Learn how to set or override the transaction name to capture the user and gain critical pieces of information that construct a unique identity in Sentry."
---

The current transaction name is used to group transactions in our [Performance](/product/performance/) product, as well as annotate error events with their point of failure.
The current transaction name is used to group transactions in our [Insights](/product/insights/) product, as well as annotate error events with their point of failure.

The transaction name can reference the current web app route, or the current
task being executed. For example:
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/features/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Let us know if you have feedback by filing a <Link to="https://github.com/getsen
- <Link to="/product/releases/health">Release health</Link>, tracking crash-free users and sessions.
- <PlatformLink to="/enriching-events/attachments">Attachments</PlatformLink> that can enrich your event by storing additional files, such as config or log files.
- <PlatformLink to="/user-feedback">User Feedback</PlatformLink>, providing the ability to collect user information when an event occurs.
- <Link to="/product/performance">Tracing</Link> that can track:
- <Link to="/product/insights/overview">Tracing</Link> that can track:
- Android activity transactions.
- User interaction transactions such as: view click, scroll, swipe, and so on.
- <PlatformLink to="/configuration/integrations/navigation">Navigation transactions</PlatformLink>.
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/overhead/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Note that increasing the max number of breadcrumbs **does not** improve performa

## Tracing and Performance Monitoring

As stated in our <Link to="/product/performance/performance-overhead">product docs on the topic</Link>, Tracing adds some overhead, but should have minimal impact on the performance of your application. In typical scenarios, the expected overhead is less than 3% of the app's resource utilization.
As stated in our <Link to="/product/insights/overview/performance-overhead">product docs on the topic</Link>, Tracing adds some overhead, but should have minimal impact on the performance of your application. In typical scenarios, the expected overhead is less than 3% of the app's resource utilization.

## Profiling

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/tracing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: "Learn how to enable tracing in your app so you can get valuable pe
sidebar_order: 4000
---

With [tracing](/product/performance/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/).
With [tracing](/product/insights/overview/), Sentry tracks your software performance, measuring metrics like throughput and latency, and displaying the impact of errors across multiple systems. Sentry captures distributed traces consisting of transactions and spans, which measure individual services and individual operations within those services. Learn more about our model in [Distributed Tracing](/product/sentry-basics/tracing/distributed-tracing/).

<Alert>

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Sentry's SDKs support sending performance metrics data to Sentry. These are nume

## Custom Measurements

In addition to automatic performance metrics, the SDK supports setting [custom performance measurements](/product/performance/metrics/#custom-performance-measurements) on transactions. This allows you to define measurements that are important to your application and send them to Sentry.
In addition to automatic performance metrics, the SDK supports setting [custom performance measurements](/product/insights/overview/metrics/#custom-performance-measurements) on transactions. This allows you to define measurements that are important to your application and send them to Sentry.

To set a performance measurement, you need to supply the following:

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/apple/common/overhead/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Note that increasing the max number of breadcrumbs **does not** improve performa

## Tracing and Performance Monitoring

As stated in our <Link to="/product/performance/performance-overhead">product docs on the topic</Link>, Tracing adds some overhead, but should have minimal impact on the performance of your application. In typical scenarios, the expected overhead is less than 3% of the app's resource utilization.
As stated in our <Link to="/product/insights/overview/performance-overhead">product docs on the topic</Link>, Tracing adds some overhead, but should have minimal impact on the performance of your application. In typical scenarios, the expected overhead is less than 3% of the app's resource utilization.

<PlatformSection supported={["apple.ios", "apple.macos"]}>

Expand Down
Loading
Loading