Skip to content

Commit

Permalink
Update performance-tracing.md
Browse files Browse the repository at this point in the history
  • Loading branch information
lomindioladiaz authored Sep 25, 2024
1 parent 8f8c8e6 commit bbc5362
Showing 1 changed file with 22 additions and 27 deletions.
49 changes: 22 additions & 27 deletions docs/features/performance-tracing.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,70 +3,65 @@ title: Performance Tracing
sidebar_position: 1
---

# Performance Tracing
# Traces

Embrace’s Performance Tracing solution gives you visibility into any app operation you’d like to track, including duration, success rate, and any contextual metadata collected at runtime that helps debug the root cause of your mobile app's performance issues. With our tool, you can quickly spot any bottlenecks in your app’s architecture, pinpoint areas you need to troubleshoot with high precision, and ultimately deliver a truly optimized user experience.
Embrace’s Traces solution gives you visibility into any app operation you’d like to track, including duration, success rate, and any contextual metadata collected at runtime that helps debug the root cause of your mobile app's performance issues. With our tool, you can quickly spot any bottlenecks in your app’s architecture, pinpoint areas you need to troubleshoot with high precision, and ultimately deliver a truly optimized user experience.

## Trace Roots View
The primary page shows all trace roots in your app, as well as summary metrics like count, error rate, percentiles of duration, and change from previous version.
## Root Spans View
The primary page shows all root spans in your app, as well as summary metrics like count, error rate, percentiles of duration, and changes from a previous version.

<img src={require('@site/static/images/trace-roots.png').default} alt="Trace roots"/>

To narrow down the instances that are summarized in this view, you can apply the following filters on the root span as well as the child spans:
To narrow down the spans that are summarized in this view, you can apply the following filters on the root span as well as the child spans:
* Name
* Duration
* Outcome
* Attributes keys and values
* Span event names

## Trace Summary View
By clicking on the name of a Trace Root in the Trace Roots view, you can see a partial listing of all the instances of that trace.
## Root Span Summary View
By clicking on the name of a Root Span in the Root Spans View, you can see a partial listing of all the instances of that Root Span.

Each row represents a specific instance of that trace being recorded. You can see its status, unique Span ID, duration, in addition to start and end times. All of these columns other than the Span ID is sortable.
Each row represents a specific instance of that Root Span being recorded. You can see its status, unique Span ID, and duration, in addition to start and end times. All of these columns other than the Span ID is sortable.

Clicking on the instance will open up an in-line preview of the details of that instance, including the child spans that it has, their duration, and whether they completed successfully.
Clicking on the instance will open up an in-line preview of the details of that instance, including the child spans that it has, their duration, and whether they were completed successfully.

On the right side each row that shows a trace instance, there are two icons. The first one takes you to the Trace Instance View, where you can see all the details about that instance, including attributes and events on each child span. The second one takes you to the specific session in the User Timeline view that this instance ended in so you can see the full context of what happened before and after this trace was recorded.
On the right side each row that shows a Root Span instance, there are two icons. The first one takes you to the Root Span Instance View, where you can see all the details about that instance, including attributes and events on each child span. The second one takes you to the specific session in the User Timeline view that this instance ended in so you can see the full context of what happened before and after this Root Span was recorded.

<img src={require('@site/static/images/trace-summary.png').default} alt="Trace summary"/>

You can filter by the same properties as in the Trace Roots View. In fact, the filters that you had set on the Trace Roots View will apply if you navigate here from there directly.
You can filter by properties similar to those in the Root Span View.

<img src={require('@site/static/images/trace-summary-filters.png').default} alt="Trace summary filters"/>

## Trace Instance View
This view show a trace in its entirety. Not only can you see all the information in trace instance preview, you can also see at the individual events and attributes recorded as part of on a each child span, along with metadata about the device and app.
## Root Span Instance View
This view shows a Root Span in its entirety. Not only can you see all the information in trace instance preview, you can also see at the individual events and attributes recorded as part of on a each child span, along with metadata about the device and app.

<img src={require('@site/static/images/trace-instance.png').default} alt="Trace instance"/>

## User Timeline view
Traces appear in both the Timeline View and Timeline Details.
Root Spans appear in both the Timeline View and Timeline Details.

Clicking on "See Details" for any trace within the timeline will take you directly the the Trace Instance View.
Clicking on "See Details" for any Root Span within the timeline will take you directly to the Root Span Instance View.

<img src={require('@site/static/images/trace-user-timeline.png').default} alt="User timeline"/>

## Sessions Filters
Not only can you filter traces in the various pages dedicated to Performance Tracing, you can filter sessions in the Sessions View by whether or not they contain specific spans with certain attributes and events.
Not only can you filter spans in the various pages dedicated to Performance Tracing, you can filter sessions in the Sessions View by whether or not they contain specific spans with certain attributes and events.

<img src={require('@site/static/images/trace-session-filters.png').default} alt="Session filters"/>

## Boards, Alerts, and Custom Metrics
You can create Boards, Alerts, and Custom Metrics based on trace data.
You can create Boards, Alerts, and Custom Metrics based on span data.

<img src={require('@site/static/images/trace-widgets.png').default} alt="Trace widgets"/>
<img src={require('@site/static/images/trace-alerts.png').default} alt="Trace alerts"/>

## Slow Traces
With the Slow Traces feature, you can identify performance bottlenecks and prioritize your optimization efforts.
Slow Traces are trace instances with both significant occurrences (100 over the last two days) and durations surpassing the 95th percentile of successful traces bearing the same name.
You can get the slow traces on the issues page.
## Slow Root Spans
With the Slow Root Spans feature, you can identify performance bottlenecks and prioritize your optimization efforts.
Slow Root Spans are instances with both significant occurrences (100 over the last two days) and durations surpassing the 95th percentile of successful spans bearing the same name.
You can get the slow Root Spans on the issues page.

<img src={require('@site/static/images/trace-slow-traces.png').default} alt="Slow traces"/>

Once you click on a slow trace, you can see specific instances of that trace.

:::info
You can also see those instances if you add the filter `type = slow` to see the on the performance traces tab.
:::

Once you click on a Slow Root Span, you can see specific instances of that span.

0 comments on commit bbc5362

Please sign in to comment.