Raygun has customizable dashboards, so you only see information you care about. This documentation will show you how to view and edit your dashboards.
Viewing your dashboards
To locate your dashboards, click on the button in the top left corner of the Raygun application. Within the drop down, switch to the Dashboards tab to view the dashboards you have access to. Click any listed dashboard to view it. Dashboards belong to plans, so if you are a member of multiple plans, you can switch between them by clicking the plan in the left hand margin of the drop down.
One of the dashboards in the image above has been labeled as Primary. Most plans have a primary dashboard that can be customized just like any other dashboard, but has a few special characteristics. The Primary dashboard starts off with a preset layout of tiles using data from your top 5 applications with the most data. The Primary dashboard has a Reset function that reverts any customizations back to the preset tile layout using data from your top 5 applications at the time of reset. The primary dashboard can not be deleted.
Another dashboard in the image above is labeled as Legacy. This will link you to the old global dashboard which can not be customized. Note that this will only be available to plans that have had a legacy dashboard. Newly created plans only have customizable dashboards.
Create custom dashboards from your APM, error and RUM data
At the core of the Dashboard is the ability to provide your team with a high level view of the health of your application. It does this with customizable dashboard tiles that can be dragged, dropped and edited as you see fit.
The data is 100% customizable and you can add as many product “tiles” onto a dashboard as you wish. Whether you need to understand more about the locations of your end users or how many are experiencing crashes in real time, Raygun will present what you need in a beautiful and user friendly Dashboard.
Here is the list of tiles you can add to your dashboard, sort by products:
- Error instances*
- Error groups count*
- Recent crashes
- Error groups*
- Errors per app*
- Error count*
* Can be filtered by error group status (e.g. Active, Resolved, Ignored, or Permanently ignored). See Filtering a tile by status below.
Real User Monitoring
- Total users
- New users
- User satisfaction
- Median session length
- Average load time
- Health score
- Returning users
- User count
- Session count
- Live health score
- Live sessions
- Live users
- Live load time
- Load time distribution
- Session distribution
- Live active sessions
These tiles are only available if you've been granted beta access to Raygun APM.
- Requests per minute (RPM)
- Average request breakdown
- Request execution speeds
Editing a dashboard
In order to make any changes at all to a customizable dashboard, you first need to switch the dashboard into edit mode. To do this, click the "Edit dashboard" button in the top right corner of a dashboard.
It's important to note that none of the changes that you make to a dashboard will be persisted until you press the green "Save changes" button in the edit bar. This applies to all of the editing functions documented in the following sections. Make sure to always save any changes you're happy with before navigating away from the dashboard you're working on. After saving changes, the dashboard will switch out of edit mode.
In order to avoid accidental saves, you'll need to click the check box and then hit "Yes, save" in the modal that appears. Everyone who can view the dashboard will see the changes that you save.
If you've made some changes to a dashboard but then want to cancel them rather than saving, click the "X" button on the right hand side of the edit bar. This will reload the dashboard and switch out of edit mode.
Since this operation is going to lose your unsaved changes, you'll need to click the check box and then hit "Yes, revert" in the modal that appears. If you don't see this modal, then no changes were made to the dashboard.
Renaming a dashboard
While in edit mode, a pencil icon will appear next to the dashboard's header. Click anywhere on the title or pencil icon, and then type in the title you want for your dashboard. The title is used to identify your dashboard in the switcher, so it helps to give your dashboards unique and meaningful names.
Adding a tile
A tile is a component of information from the Raygun Platform, such as a list of errors or a time series chart of user sessions. The highlight of Raygun dashboards are the highly configurable tiles. You can add as many tiles as you need, and can even add the same type of tile multiple times and configure them differently.
1. To add a tile, first make sure the dashboard is in edit mode.
2. In the edit bar, click on the blue "Add tile" button.
3. You'll be presented with a modal listing the various tiles you can add to your dashboard. Note that some tiles may not be available to you if you have no applications with Raygun Crash Reporting or Pulse (RUM) data. The modal allows you to search by name, and sort by name or tile type to help you find what you want to add to your dashboard. Click the blue "Select" button next to a listed tile that you want to add to your dashboard.
4. To finish up, configure the tile with the data you want to display.
- Most tiles have a title that gets displayed in their headers.
- Some tiles have a date range to fetch the data from, whereas other tiles represent live values of what's happening right now.
- Use the "Select application" drop down to specify where to source the tiles data from. A single tile can source data from any number of your applications.
- The above image is just one example of configuring a tile. Different types of tiles can have different options specific to what they display.
5. The blue "Add tile" button will be disabled until you've configured enough information for the tile to display data. The main thing you usually need to add is the applications to fetch the data from. Once you're ready, click "Add tile" for the tile to be added to your dashboard which will then scroll into view.
Moving a tile
Any of the tiles can be moved around while the dashboard is in edit mode. This allows you to customize the tile layout and display them in a preferred arrangement.
Move a tile by holding down the left mouse button over any non-interactive area of a tile. Then, drag and drop the tile to another place on the grid. As you drag a tile around, other tiles will move out of the way, and when dropped, the tile will automatically snap to the grid.
Resizing a tile
No customizable dashboard can be without the ability to resize tiles, which aids in achieving your ideal tile layout.
While the dashboard is in edit mode, drag the arrow in the bottom right corner of any tile to resize it.
Just like moving a tile, the dimensions of the tile will snap to the grid when the resize handle is dropped. Some tiles have a minimum size, (e.g. 2x3 grid units), and cannot be resized smaller than their minimum.
Configuring a tile
Any options that you configure while adding a tile can be revisited. To open the tile configuration modal, make sure the dashboard is in edit mode, then click the cog icon in the top right corner of any tile you want to edit.
Once you're done editing any of the tile's options, click the green "Apply" button.
Filtering a tile by status
The marked tiles above under Crash Reporting can be filtered by error group status. Error group statuses include: Active, Resolved, Ignored, and Permanently ignored.
The error-based tiles which can be filtered by status are:
- Error count
- Error groups
- Errors per app
- Error instances
- Error Groups count
To apply a status filter:
1. Click the Edit Dashboard in the top-right corner of the page
2. Click the settings icon in the top-right corner of the error-based tile you want to filter and you'll see the Statuses to include list.
3. Check the Resolved option, and change the title to reflect the new status (optional)
4. The error group list tile will now only show Resolved error groups
Tiles that require multiple products
Some tiles (such as the Crash Free Users tile) require all or multiple Raygun products to be enabled before we can accurately display the data.
For example, the Crash Free Users tile requires both Raygun Crash Reporting and Real User Monitoring to be enabled and receiving data.
With the Crash free Users tile, Raygun Crash Reporting and Real User Monitoring work together to surface the percenteage of all users who have experienced software errors over the time range. This allows you to:
- Set a benchmark around this percentage and aim to improve
- Understand which errors affect user experience, right down to the stack trace
- Give priority to the software errors affecting your User Satisfaction score
To learn more about how to enable Raygun products for your applications, check out our docs for getting started with Crash Reporting and Real User Monitoring.
Renaming a tile
The title is one of the options available in a tile's configuration modal. If the title is the only thing you want to change on a tile, then you can alternatively edit the title in-place. When the dashboard is in edit mode, a pencil icon is displayed next to each tile's header. Clicking anywhere on the title or the pencil icon will allow you to type in a new title.
Deleting a tile
1. You can remove a tile from your dashboard while in edit mode by first clicking the cog icon in the top right corner of the tile you want to remove.
2. In the bottom left corner of the tile configuration modal, hit the "Delete" button.
3. As this is a destructive action, you'll need to check the box and click "Yes, delete" in the next modal that appears.
Clearing all tiles
If you want to re do a dashboard from scratch, you can clear the dashboard which will remove all the tiles. While in edit mode, click the "Clear" button near the left hand side of the edit bar.
This will look slightly different if you are currently working on your plan's primary dashboard.
As this operation will lose any other edits you've made while in edit mode, you'll need to click the check box and hit "Yes, clear" in the modal to avoid accidents. Note that clearing the dashboard does not persist until you save changes when you're done editing.
Resetting the primary dashboard
Resetting is a function only available to a plan's primary dashboard. Resetting will find your top 5 applications with the most data and replace everything on the primary dashboard with a preset tile layout. In edit mode, click the "Reset dashboard" button within the left hand drop down of the edit bar.
This operation will lose any other edits you've made, so you'll need to click the check box and hit "Yes, reset" in order to confirm this function. Just like all other dashboard editing operations, none of the affects that resetting has on the primary dashboard will be persisted until you save changes.
Creating a dashboard
To add a whole new dashboard to your plan, open the switcher in the very top left corner of the Raygun application. If you have multiple plans, select which plan you want to add a dashboard to in the left hand margin. Make sure you're viewing the "Dashboards" tab, and then press the blue "Create dashboard" button.
The dashboard is created instantly and added to the plan. The dashboard will start out in edit mode so that you can get straight into the customizations. Remember to give your new dashboard a meaningful name. You'll need to save changes in order to persist any edits you make.
Note that different Raygun plans have different limits on how many dashboards you can create.
Deleting a dashboard
If you have a dashboard that you don't need anymore, you can delete it while the dashboard is in edit mode. Click the "Delete" button on the left hand side of the edit bar. Note that all Raygun plans have one primary dashboard that can not be deleted. If you do not see the "Delete" button, it will be because you're currently working on your plan's primary dashboard.
As this is a destructive operation that can not be undone, you'll need to click the check box and press "Yes, delete" in order to finalize this operation.
Information displayed on your dashboards will update every few minutes, providing you with a live view. You may choose to switch to TV mode and have the dashboard on a permanent screen to monitor your applications.
You can put a dashboard into TV mode by clicking the TV icon on the right hand side of the header bar. TV mode is only available if the dashboard is not in edit mode.
In TV mode, click on the pin icon to unpin/hide the header bar. The header bar can be accessed again by moving the mouse against the top of the screen. To exit TV mode, you can either click the "X" button in the header bar, or press the Esc keyboard key.