Console 2.0 is a new interface and interaction model for working with Backtrace. It was developed to support the needs of team members such as Engineers and Engineering Managers, QA and Support personnel, and Business or Product leaders.
- Engineering Managers - Triage the incoming errors (crashes and exceptions), and review the status of assigned errors.
- Engineers - Debug and resolve errors assigned to them. Possibly self-assign errors not yet assigned.
- QA Personnel - Review the stability of a new release under development, identify regressions that occur and understand new tests required.
- Support Staff - Research a problem reported by a customer. Understand if errors have been fixed or what the workaround might be.
- Business and Product leaders - Understand the overall health of the system. Look for early warning indicators for positive or negative trends.
Console 2.0 is also focused on simplifying setting and management of the system.
This document will serve as a guide for using Console 2.0 as it enters its public beta phase.
Enable or Disable Access
If the beta is enabled for your organization, you should see a banner for you to opt in.
- If you want to be enabled and don't see the banner, please reach out via the chat in the bottom right.
- If you see the banner but want to remove it for you or others in your organization, please reach out via the chat in the bottom right.
Getting Around in Console 2.0
As you look from upper left to upper right you'll see the following:
- Project Selector - use this to switch between various projects that are reporting crashes or errors.
- Tools - Triage | Explore | List | Debug - These are your top level tools for viewing data in your project. We'll start with the Triage tool, which allows you to see crashes or errors with the most number of occurrences, and allow you to take action, such as assign, link to Jira ticket, and more. You also have the Explore tool, which allows you to group and visualize your data in useful ways, the List tool, which allows you to list specific occurrences of errors, and the Debug tool, which allows you to view a specific error report, including a symbolicated call stack, system and custom attributes, and other useful information.
- Utilities - On the far right, you have a link to open Saved Views, which allow you to save common views for easy access, You also have your first initial with a context menu to see Settings and other top level functions (Invite a user, Create a Project) that are available to you.
When first launching the app, you will default to the Triage tool for the selected project. The Triage tool displays crashes or errors grouped by fingerprint (a hash we generate when processing crashes through Backtrace's deduplication algorithms). The Triage tool allows you to filter down which crashes you want to view, and provides information so you can prioritize and decide what actions to take to resolve the issue.
The first item to draw your attention to are the various filters you can use to view the information that is most important to you.
On the top left, you can add filters identifying crashes from a certain version, a certain user, specific operating system, or more. Filters are available on any system or custom metadata that you provide with your crashes. You can take advantage of powerful filter operators that go beyond the normal equals or contains operators to include not-contains, regular-expression, inverse-regular-expression, at-least, or at-most, depending on the data type. See the image below for examples of the different operators available.
On the top right, you'll see filters for Time Frame. This allows you to filter for issues that have occurred during a certain time period, or when an issue was first seen, which is useful for identifying when specifically an issue may have been introduced.
Finally, you'll notice shortcuts to apply Open, In Progress, Resolved, Muted or All state filters. These states help engineering managers and engineers know which crashes need analysis, which are being actively worked on, which are resolved, and which can be ignored or muted. There is also a shortcut for "Assigned to me" to view crashes that are assigned to the current user.
After you have selected appropriate filters, you'll be presented with a result list of that is full of information. Let's dive in:
First, at the top of the list, you'll see some informational text that tells you how many issues are being displayed and how many in total there are. This gives you a view of how many additional crashes or errors that are identified outside the filter window.
For each fingerprint in the result list you can view and modify data:
- View and modify the state from Open/In Progress to Resolved and Muted.
- View crash or error ID of the fingerprint and head of the call stack.
- View the number of occurrences and number of impacted hosts or users, and activity history.
- View system applied tags (classifiers), and manage custom tags.
- View and manage assignees and linked tickets.
Click on the head of a call stack in the result list, to open a full page view of the call stack, complete with the ability to apply additional filters based on lines in the call stack, or ability to copy the call stack to the clipboard.
A note on Open, In Progress, Resolved and Muted states:
- Fingerprints can be marked as Resolved or Muted using the state column. If a fingerprint is marked as Resolved or Muted, it will stay in that state until it either seen again (Resolved) or if it is seen after some period of time (Muted).
- Note: Logic to move errors our of Resolved or Muted state will be delivered after the initial public beta.
- A fingerprint is Open if there are no assignees or linked tickets (and has not been marked as Resolved or Muted). The act of assigning a fingerprint or linking it to a ticket will cause the Open fingerprint to be listed as In Progress. By the same notion, a fingerprint that is In Progress and has its assignees removed and tickets unlinked will be listed as Open.
Click on a result in the result list to open a detailed view of fingerprint. You will also have the ability to add attributes to the detailed view of the fingerprint so you can see how values are distributed amongst the set of crash occurances.
The Explore tool exposes the power of query on your diagnostic data. Useful when you want to group by other attributes.
You are able to use the same filters discussed in the Triage tool, and further use Group By and Aggregate functions to slice and dice your data by other attributes like version, user, app module, and more
More details on the List and Debug tools, and Settings, will be provided as the beta continues.