Skip to content

Commit

Permalink
✏️ Update breadcrumb docs
Browse files Browse the repository at this point in the history
  • Loading branch information
leeandher committed Jul 12, 2024
1 parent 3e3087d commit 36cab9e
Show file tree
Hide file tree
Showing 7 changed files with 18 additions and 34 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
52 changes: 18 additions & 34 deletions docs/product/issues/issue-details/breadcrumbs/index.mdx
Original file line number Diff line number Diff line change
@@ -1,61 +1,45 @@
---
title: Using Breadcrumbs
description: "Learn about using breadcrumbs on the Issue Details page to help resolve issues."
description: "Learn about using breadcrumbs on the Issue Details page to debug."
sidebar_order: 40
---

Sentry uses _breadcrumbs_ to create a trail of events that happened prior to an issue. These events are very similar to traditional logs, but can record more rich structured data.

SDKs automatically start recording breadcrumbs by enabling integrations. To learn how to do this for your platform, select the platform from the dropdown at the top of the page, then review the breadcrumbs documentation for that platform.

If an error event provides a trail, [sentry.io](https://sentry.io) displays the breadcrumbs on the **Issue Details** page:
If an error event provides a trail, [sentry.io](https://sentry.io) displays the breadcrumbs on the **Issue Details** page.

![Breadcrumbs section](./img/breadcrumbs-section.png)
![Breadcrumbs section](../img/issue-breadcrumbs.png)

## Breadcrumbs Display

Each part of the breadcrumb displays in a separate row and each row includes the following details: Type, Category, Description, Level, and Time.
On the main issue details page, you'll only see a portion of the breadcrumbs that may be available for the event. To access the rest of them, click the 'View All' button at the bottom of the section. This will open a slide out drawer where you can search, filter, sort and change the time display for all the breadcrumbs. To close this drawer, click 'Close' or press the escape key.

Type
In the drawer the following controls are accessible:
- **Search**: Shows only breadcrumbs that match the query. Matches can occur on `type`, `category`, `message` and `data`.
- **Filter**: The list of breadcrumbs can be filtered by the associated `type`.
- **Sort**: Determines how breadcrumbs will be ordered, either Newest first or Oldest first. Your sort preference is saved to the browser.
- **Time Display** Determines how breadcrumb timestamps will be displayed, either as absolute timestamps (respecting user preferences for 24-hour clocks/timezone), or relative to the first breadcrumb in the list. Relative timestamps that appear negative indicate they took place before the event first breadcrumb. Your time display preference is saved to the browser.

A semi-internal attribute `type` can control the type of the breadcrumb. By default, all breadcrumbs are recorded as `default`, which makes them appear as a `Debug` entry, but Sentry provides other [types](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#breadcrumb-types) that influence how the breadcrumbs are rendered.
![Breadcrumbs drawer](./img/breadcrumbs-drawer.png)

Category

The category of the event. This data is similar to a logger name, and helps you understand the area in which an event took place, such as auth.
## Breadcrumbs Attributes

Description
Each breadcrumb is composed of the following details:

A description is either:
- **Type**: A semi-internal attribute `type` can control the type of the breadcrumb. By default, all breadcrumbs are recorded as `default`, but Sentry provides other [types](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/#breadcrumb-types) that influence the color/icon associated with the breadcrumb in the UI.

- Message: A string describing the event, rendered as text with all whitespace preserved. It's often used as a drop-in for a traditional log message.
- **Category**: The category of the event. This data is similar to a logger name, and helps you understand the area in which an event took place, such as `auth`. In the UI, period characters are replaced with space (e.g. `ui.click` becomes `UI Click`)

- Data: A key-value mapping of event metadata. This is often used instead of a message, but may be used in addition to one. [sentry.io](https://sentry.io) displays all the data sent.
- **Message**: A string describing the event, rendered as text with all whitespace preserved. It's often used as a drop-in for a traditional log message.

Level
- **Data**: A key-value mapping of breadcrumb's arbitrary data. Useful for attaching structured information related to the breadcrumb, like IDs or variable values.

The severity of an event. The level is set to one of five values, which are — in order of severity — fatal, error, warning, info, and debug.
- **Level**: The severity of an event. The level is set to one of five values, which are — in order of severity — fatal, error, warning, info, and debug.

Time
- **Time**: A timestamp representing when the breadcrumb occurred. The format is either a string, as defined in [RFC 3339](https://tools.ietf.org/html/rfc3339), or a numeric value representing the number of seconds that have elapsed since the Unix epoch.

A timestamp representing when the breadcrumb occurred. The format is either a string, as defined in [RFC 3339](https://tools.ietf.org/html/rfc3339), or a numeric (integer or float) value representing the number of seconds that have elapsed since the Unix epoch. By default, [sentry.io](https://sentry.io) displays the timestamp as an absolute time. You can click the toggle to update the display to relative time:

![Switch time format button](./img/breadcrumbs-relative-time-switch.png)

Learn more detailed information about breadcrumb data in the [Breadcrumbs Interface developer documentation](https://develop.sentry.dev/sdk/event-payloads/breadcrumbs/).

## Filtering the Display

You can filter the list of breadcrumbs by type and level. The provided types and levels are displayed as options in the filter:

![Filter By Types/Levels](./img/breadcrumbs-filter-by.png)

## Full-Text Search

If you type anything in the filter search field, [sentry.io](https://sentry.io) filters out all fragmented data and attempts to find a match to the search criteria. If it finds one, the match is highlighted. Full-text search also works in conjunction with Filter By.

## Sorting

By default, breadcrumbs are sorted from newest to oldest. If you prefer a different ordering, use the dropdown to the right of the search bar. Your sort preference will be saved to the browser.

![Breadcrumbs sort dropdown](./img/breadcrumbs-sort.png)
Binary file modified docs/product/issues/issue-details/img/issue-breadcrumbs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 36cab9e

Please sign in to comment.