Skip to content

Commit

Permalink
update event detail mentions (#10187)
Browse files Browse the repository at this point in the history
* update event detail mentions

* Update docs/product/performance/web-vitals/index.mdx

* small tweaks to trace details page

* Update docs/product/performance/transaction-summary.mdx

Co-authored-by: vivianyentran <[email protected]>

* Update docs/concepts/key-terms/tracing/distributed-tracing.mdx

* Update docs/platforms/java/guides/spring/advanced-usage.mdx

* Update docs/product/performance/resources.mdx

Co-authored-by: vivianyentran <[email protected]>

* Update docs/product/performance/web-vitals/index.mdx

Co-authored-by: vivianyentran <[email protected]>

* Update docs/concepts/key-terms/tracing/index.mdx

* Update docs/product/performance/mobile-vitals/screen-loads.mdx

* Update docs/product/performance/queries.mdx

* add redirect

* Update docs/concepts/key-terms/tracing/distributed-tracing.mdx

* Update docs/platforms/java/guides/spring/advanced-usage.mdx

* Update docs/product/performance/queries.mdx

* Update docs/concepts/key-terms/tracing/index.mdx

* Update docs/product/performance/mobile-vitals/screen-loads.mdx

* Update docs/product/performance/transaction-summary.mdx

* Update docs/product/performance/resources.mdx

* Update docs/product/performance/web-vitals/index.mdx

---------

Co-authored-by: vivianyentran <[email protected]>
  • Loading branch information
lizokm and vivianyentran committed Jun 2, 2024
1 parent 9d356ae commit ff62376
Show file tree
Hide file tree
Showing 17 changed files with 25 additions and 145 deletions.
2 changes: 1 addition & 1 deletion docs/concepts/key-terms/tracing/distributed-tracing.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -243,4 +243,4 @@ Put simply: as a result of this head-based approach, where the decision is made

## Viewing Trace Data

Through [Performance](/product/performance/) and [Discover](/product/discover-queries/), you can view trace data in the [event details](/product/sentry-basics/concepts/tracing/event-detail/).
Through [Performance](/product/performance/) and [Discover](/product/discover-queries/), you can view trace data in the [Trace Details](/concepts/key-terms/tracing/trace-view/) page.
122 changes: 0 additions & 122 deletions docs/concepts/key-terms/tracing/event-detail.mdx

This file was deleted.

2 changes: 1 addition & 1 deletion docs/concepts/key-terms/tracing/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: "Learn more about the tracing features Sentry offers to help you tr

[Distributed tracing](/product/sentry-basics/tracing/distributed-tracing/) provides a connected view of related errors and transactions by capturing interactions among your software systems. With tracing, Sentry tracks your software performance and displays the impact of errors across multiple systems. Tracing issues back through services connects your front-end to your back-end.

The [Trace View](/product/sentry-basics/tracing/trace-view/) allows you to drill down into the details of a single trace and traverse every transaction in that trace. This accelerates your ability to debug slow services, identify related errors, and root out other bottlenecks. You can also drill all the way down into a span for a single transaction and information about it on the [Event Detail](/product/sentry-basics/tracing/event-detail/) page.
The [Trace Details](/product/sentry-basics/tracing/trace-view/) allows you to drill down into the details of a single trace and traverse every transaction in that trace. This accelerates your ability to debug slow services, identify related errors, and root out other bottlenecks.

## Learn More

Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/android/configuration/gradle.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -433,7 +433,7 @@ Checkout the full documentation on <PlatformLink to="/enhance-errors/source-cont
## Tracing Auto-instrumentation

The plugin uses the [bytecode manipulation](https://www.infoq.com/articles/Living-Matrix-Bytecode-Manipulation/) framework to inject a code snippet
that starts and finishes a [span](/product/sentry-basics/tracing/event-detail/#span-view) for common operations that can cause performance bottlenecks.
that starts and finishes a [span](/concepts/key-terms/tracing/trace-view/#product-walkthrough-trace-view-page) for common operations that can cause performance bottlenecks.
This way potentially heavy operations are automatically measured without the need to manually instrument them.

<Note>
Expand Down
2 changes: 1 addition & 1 deletion docs/platforms/java/guides/spring/advanced-usage.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Record user information from an HTTP request or by registering a Spring bean for

## Recording User Information From HTTP Request

To record the user's IP address and `Principal#name` as the username so you can then view in [Event Details](/product/performance/event-detail/):
To record the user's IP address and `Principal#name` as the username so you can then view in [trace details view](/concepts/key-terms/tracing/trace-view/):

1. Set the personal information flag on `@EnableSentry` to `true`.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 3 additions & 5 deletions docs/product/discover-queries/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -110,10 +110,8 @@ If the first column shows an icon (as seen above), it means the events have been

For more about how to build a query, go to [the Query Builder](/product/discover-queries/query-builder/).

## Event Details
## Trace Details

![Event detail page displaying a graph with spikes, the event details, and different metrics for tags.](./img/discover-event-details.png)
![Trace Details View](./img/trace-details-view.png)

Navigate to the Event Details page from **Discover > [Saved Query] > Event Detail**. You'll find all the relevant details about a single event. For every event, you will see the ID, timestamp, and link to view the normalized JSON payload that Sentry received.

The Event Detail view varies depending on event type (error, transaction, csp). [Transaction event details](/product/performance/event-detail/) may have an entirely different view from error event details (as shown above). For example, errors may have a related issue shown in the sidebar. This gives you a quick glance at the event volume for that issue and lets you quickly navigate to the related issue. You may also find stack traces, breadcrumbs, and more in these views.
You can see additional information about your event by clicking into any "Event ID" on the [**Discover**](https://sentry.io/orgredirect/organizations/:orgslug/discover) page. Clicking on any event type other than an error event, will take you to the [**Trace Details**](/concepts/key-terms/tracing/trace-view/) page. Clicking on an error event will take you to the [**Issues**](https://sentry.io/orgredirect/organizations/:orgslug/issues/) page.
2 changes: 1 addition & 1 deletion docs/product/performance/getting-started.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_order: 1
description: "Get started with Sentry's Performance Monitoring, which allows you to see macro-level metrics to micro-level spans, cross-reference transactions with related issues, and customize queries."
---

If you don't already have performance monitoring enabled, use the links for supported SDKs below to quickly set up access to our [Performance Monitoring](/product/performance/) features. Performance Monitoring helps you see everything from macro-level [metrics](/product/performance/metrics/) to micro-level [spans](/product/performance/event-detail/), and you'll be able to cross-reference [transactions with related issues](/product/performance/transaction-summary/), customize [queries](/product/discover-queries/query-builder/) based on your personal needs, and substantially more.
If you don't already have performance monitoring enabled, use the links for supported SDKs below to quickly set up access to our [Performance Monitoring](/product/performance/) features. Performance Monitoring helps you see everything from macro-level [metrics](/product/performance/metrics/) to micro-level [spans](/concepts/key-terms/tracing/trace-view/#product-walkthrough-trace-view-page), and you'll be able to cross-reference [transactions with related issues](/product/performance/transaction-summary/), customize [queries](/product/discover-queries/query-builder/) based on your personal needs, and substantially more.

## Supported SDKs

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/product/performance/metrics.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -117,10 +117,10 @@ Custom metrics are accessible to you in [sentry.io](https://sentry.io) when you:

- Create visualizations in **Dashboards**
- Query and add columns for them in **Discover**
- View a transaction event detail (see image below)
- View a transaction trace detail (see image below)

![Custom metrics in an event detail](./img/custom-metrics-performance.png)
![Custom metrics in an trace detail](./img/transaction-trace-detail.png)

> _Custom metrics data displayed in the sidebar of a transaction event detail under the "Custom Performance Metrics" heading._
> _Custom metrics data displayed in the sidebar of a transaction trace detail under the "Custom Performance Metrics" heading._
You can define up to 10 custom performance metrics per transaction. If more custom performance metrics are included in a transaction event, the list will be truncated.
2 changes: 1 addition & 1 deletion docs/product/performance/mobile-vitals/app-starts.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -104,4 +104,4 @@ Sentry automatically identifies sample events to help you investigate performanc

You can use the sample list to drill down to and compare fast, average, and slow events of interest within a given screen.

Clicking on a sample event will take you into either the query’s span details within the span waterfall of the **Event Details** page or the profile icon to see the [flamegraph](/product/profiling/flame-charts-graphs/) for the event. To get different event samples, click the "Try Different Samples" button.
Clicking on a sample event will take you into either the query’s span details within the span waterfall of the [Trace View page](/concepts/key-terms/tracing/trace-view/#product-walkthrough-trace-view-page) or the profile icon to see the [flamegraph](/product/profiling/flame-charts-graphs/) for the event. To get different event samples, click the "Try Different Samples" button.
2 changes: 1 addition & 1 deletion docs/product/performance/mobile-vitals/screen-loads.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -88,4 +88,4 @@ Sentry automatically identifies sample events to help you investigate performanc

You can use the sample list to drill down to and compare fast, average, and slow events of interest within a given screen.

Clicking on a sample event will take you into either the query's span details within the span waterfall of the **Event Details** page or the profile icon to see the [flamegraph](/product/profiling/flame-charts-graphs/) for the event. To get different event samples, click the "Try Different Samples" button.
Clicking on a sample event will take you into either the query's span details within the span waterfall of the [Trace Details page](/concepts/key-terms/tracing/trace-view/) or the profile icon to see the [flamegraph](/product/profiling/flame-charts-graphs/) for the event. To get different event samples, click the "Try Different Samples" button.
4 changes: 2 additions & 2 deletions docs/product/performance/queries.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,7 +101,7 @@ Query Sources are currently supported in Sentry's [Laravel](/platforms/php/guide

A query's source is the location in your application's code that triggered the query. Sentry automatically determines the query source by examining the stack trace and attaches the source to the query data.

You can see the query's source underneath the query description on the **Query Summary** page, as shown in the image below. You can also find the query's source on the [**Event Details** page](/product/sentry-basics/concepts/tracing/event-detail/) next to other span properties in the span waterfall. 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.
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)

Expand All @@ -117,7 +117,7 @@ These same events are also represented as triangles shown in the average duratio

You can generate a new list of random sample events by clicking the "Try Different Samples" button at the bottom.

From the sample list, you can drill down to specific good, average, or bad examples of a given query within a given endpoint. Click on an event ID to drill into the query's span details within the span waterfall of the **Event Details** page.
From the sample list, you can drill down to specific good, average, or bad examples of a given query within a given endpoint. Click on an event ID to drill into the query's span details within the span waterfall of the [Trace Details page](/concepts/key-terms/tracing/trace-view/).

The gif below explains how to navigate the sample list.

Expand Down
2 changes: 1 addition & 1 deletion docs/product/performance/resources.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,6 @@ These same events are also represented as triangles shown in the average duratio

You can generate a new list of random sample events by clicking the "Try Different Samples" button at the bottom.

From the sample list, you can drill down to specific good, average, or bad examples of a given resource within a given page. Click on an event ID to drill into the resource's span details within the span waterfall of the **Event Details** page.
From the sample list, you can drill down to specific good, average, or bad examples of a given resource within a given page. Click on an event ID to drill into the resource's span details within the span waterfall of the [Trace Details](/concepts/key-terms/tracing/trace-view/#product-walkthrough-trace-details-page) page.

<div style={{position: 'relative', paddingBottom: 'calc(50.829268292682926% + 41px)', height: 0}}><iframe src="https://demo.arcade.software/h2B547DqgJGIrlsMeVWx?embed" frameborder="0" loading="lazy" webkitallowfullscreen mozallowfullscreen allowfullscreen style={{position: 'absolute', top: 0, left: 0, width: '100%', height: '100%', colorScheme: 'light'}}></iframe></div>
Loading

0 comments on commit ff62376

Please sign in to comment.