roubleshooting Synergy with Sentry
Contents
Document Details
Prepared By | Reviewed By | Date | Document Version |
Ashima Agarwal | Artem Kalaitan | 15-June-2022 | V 2 |
Sentry Overview
Sentry is an application that is used for real time error tracking in production which would happen due to security bug, invalid data etc. and understand the end customer experiences. It also helps in boosting efficiency and improving the end-user experience. In the below sections we will navigate into Sentry and explore various options.
Sign In
Sentry provides multiple options to Sign into the system, chose the option relevant to your organizations. In the e.g., below we use the Sign in with Google option.
Link: https://sentry.io/auth/login/
Figure 1
A confirmation link will be sent to the email address and once the email validation is completed user will be able to login into the application.
Figure 2
The landing page after the login is displayed as below:
Figure 3
On the left side of the application there are options to perform various activities. In the sections below we will go through each of the option one by one.
Projects
On the Projects sections, user will be able to see the different projects he is has access to. This page is like an overview of all the projects using Sentry. Right now, we can see Synergy and Scan Manager. The user can also create a new project but only with the right access
Figure 4
The Join Team gives the option to join another team in the organisation. Clicking on the Join team button will navigate the user to Teams page where we only have one team as seen below.
Figure 5
Clicking on the Project name, user will navigate to the Project Details page which provides an overview over errors, performance, and the health of your releases.
Figure 6
Project Details
This page gives the options to filter the details of the project based on Environment or the number of days (defaulted to 14 Days).
Figure 7
The four cards displayed on the project details page is as below:
Crash free sessions - The percentage of sessions in the provided time range that did not terminate in a crash of the application is the crash-free sessions number.
Crash free users - The percentage of distinct users that did not suffer a crash during the specified time period is the crash-free user’s number.
Number of releases - This shows the number of releases for this particular project.
Apdex - This is a statistic for tracking and measuring user satisfaction based on the reaction times of your application.
Figure 8
There are two graphs displayed on the screen which can be toggled using the display option. The total 8 graphs that can be viewed are:
Crash free sessions
Crash free Users
Number of errors
Number of sessions
Number of transactions
Figure 9
On the very bottom of the Project Detail page the consolidated view of the issues is displayed, with a clickable link that will navigate to the details of the issue.
Figure 10
Issues
This page displays information about errors in your application. This page is like an overview of all the issues in the project. The user can view the issue by filtering based on Project, Environment and Time.
Figure 11
The page is organized into tabs, each corresponding to a list of issues.
All Unresolved: All unresolved issues, including issues that need review.
For Review: Issues that need to be reviewed; for-review issues are a sub-set of all unresolved issues.
Ignored: All ignored issues.
Saved Searches: Select from a set of recommended and custom saved searches. The name of the tab changes based on your selection. The different options here are:
Assigned to Me
Errors Only
My Issues
Needs Triage
New Today
Unhandled Errors
Figure 12
For each issue, the page displays:
Error type and message: Like in the example below it says Consumer Error
Brief description of the issue: “ssl://Focus-server.forcepoint…
Associated project: Synergy-1H
Issue timing: 11 min ago-2mo Old
Graph: Shows a 24-hr timeline of the issue.
Events: This is the number of similar events in the last 14 Days i.e. 1.6k
Users: Number of users facing the same issue. E.g., 1
Assignee: To whom is the issue assigned from the team to work on.
Figure 13
Issue Details
This page helps you to gain further insight into the source of the issue and the impact it has on your application's users. The color on the issue name describes types of issue as below:
Error - orange
Info - blue
Warning - yellow
Fatal - red
Debug - gray
Sample – purple
Figure 14
The multiple tabs that can been seen on this page are:
Details: This is the default tab when user opens the Issues and it has all the details about the issue like IP address, Server Name, OS, Environment etc.
Activity: This tab logs all the activity related to the issue like if there are any status change or if any user has posted comment on the issue.
User Feedback: If user has provided any information, it will be displayed here.
Attachments: The attachments related to the issue can be found on this tab
Tags: Tags help in indexing and searching the issue on various categories.
Events: This tab will categories the issues based on the events occurred on that day.
Merged Issues: If there are issues merged it will be displayed here.
Similar Issues: Similar kinds of issues are displayed on this tab.
Figure 15
If the user scrolls below on the Detail tab, he will be able to see the breadcrumbs. Sentry creates a trail of activities that occurred prior to an issue by using breadcrumbs. These events are comparable to standard logs, but they have the ability to record more structured data.
Figure 16
Link Jira Issue: User can link the issue to Jira using the link present on the right side of the Issue Detail page. All the Details are pre-populated while creating the issue.
Figure 17
Figure 18
Performance
Sentry watches application performance, measures parameters like throughput and latency, and illustrates the effect of mistakes across various services via performance monitoring. The page includes graphs that depict transactions or trends, as well as a table that allows you to view important transactions and drill down for more information. The 4 tabs on this page is:
All Transactions
Web Vitals
Front End
Back End
Mobile
Figure 19
The graphs can be toggled, and other important metrics can be shown as below:
Figure 20
Figure 21
If the user scrolls further down the individual transaction with a clickable link is displayed, which will give further details about the performance of the application.
Figure 22
After clicking on the Transaction link, the details are displayed as below:
Figure 23
Releases
A release is a version of your code that has been delivered to a system. When you tell Sentry about a release, you may quickly detect new issues and regressions, as well as determine whether an issue will be resolved in the following release.
The Release page has the option to filer using the environment and the number of days. The page gives an overview of the releases done like
Project Name
Adoption: This shows how many numbers of users have started using the new release.
Time
Crash Free Rate
Crashes
New Issues
Figure 24
If the user clicks on any of the releases it will be navigated to the Release detail page where one can find additional information about the release.
Crash Free Session Rate
Crash Free Session Rate
Failure Rate
Session Duration p50
Session Count
User Count
Error Count
Transaction Count
Figure 25
The release detail page will also show the list of issues associated with the release.
Figure 26
User Feedback
Users that encountered an error while using your application can leave comments on the User Feedback page. Each submission includes the user's name and email address, as well as a description of what went wrong to cause the issue. When the user clicks on the link, the page will be redirected to the Issues page for further investigation.
Figure 27
Alerts
Alerts give you real-time visibility into code issues and their consequences for your users. There are a variety of notifications to choose from to make the alerts highly informative. Clicking on the alert will display the details related to the alert and the issue related to it.
Figure 28
Figure 29
User can also create new alerts as per the events he wants to get notified immediately. List of conditions can be selected from the below displayed options.
Figure 30
Figure 31
Discover
By building on and improving existing error data, Discover delivers visibility into your data across environments. You can run queries to learn more about the health of your entire system and receive answers to important questions. There are some predefined queries that the user can use or can also create his own quires.
Figure 32
Dashboard
This page allows you to traverse through error and performance data across various projects to get a broad picture of your application's health. Dashboard comprises of multiple widgets to display the information and widgets utilize the discover query to get the required data. Multiple templates are provided to get user started. User can also create its custom dashboard.
Figure 33
Clicking on one of the dashboards gives us the below details.
Figure 34
Activity
This page logs all the activity related to the application that has taken place like if there are any new user, or new project.
Figure 35
Stats
This page gives information about Usage, Issues and Health of the various projects using Sentry in the organisation.
Usage: The details on the page show high-level event usage statistics, such as the total number of events for the time and which were accepted, filtered, or rejected.
Figure 36
Issues: This page indicates how many new issues were discovered, how many resolved issues regressed, and how they were triaged for issues assigned to your team.
Figure 37
Health: This page how’s information on your projects' overall health; the crash-free sessions, alerts etc.
Figure 38
Settings
This page gives the ability to manage settings at the organizational level, only members with access can edit the settings
Figure 39
In settings under the integrations page the user will find multiple options to integrate Sentry with other tools. These settings can only be accessible to the user with manager/owner role.
Figure 40
End of Document