What you name your checks and reports in Rigor is important. You want to make sure that when you view a report or an alert that you can easily identify which site, endpoint, or user flow failed. You may also want to make sure that it’s easy to search and find your checks within your Rigor account.
There are two main ways to organize checks in Rigor:
- With tags: a set of string-based tags configured on the ‘Advanced’ tab that are great for lightweight organization and building comparison reports, or
- With naming conventions: a set of rules that you and your team agree to use when creating and naming new checks or reports
Naming conventions can be especially helpful if you share your Rigor instance with multiple teams or if you monitor sites, endpoints, or user flows for multiple brands or groups of web properties. In this post, we’ll cover a few ideas for different types of naming conventions that can make it easier to find or identify groups of checks in a single Rigor account.
Naming Conventions for Checks
[Group] - Target Purpose - Subtype (Label)
Group (Optional): Pre-pend group, brand, or team names to the front of each check so that they can be easily sorted.
Eg. Brand A/Brand B, Europe/Asia
Target (Optional): Refer to the segment of a website that you are trying to target.
Eg. Mobile Site, Homepage, API, Payment
Purpose: Represent a metric-based goal for the check or a user flow or transaction that the check monitors.
Eg. Performance, Uptime, Size, Checkout Process, Login Process
Subtype (Optional): Group different sets of checks together for comparison. Note: tags may be more ideal for grouping subtypes, especially if you want to build a comparison report.
Eg. Source/Origin, Ads/No Ads, Mobile/Desktop/Tablet, With Exclusions/Without Exclusions
Label (Optional): Differentiate between duplicate checks.
Eg. Test, Copy, East/West
When naming conventions are applied consistently, we can easily filter and order checks by name:
Naming Conventions for Dashboards and Reports
Often, dashboards and reports are stand-alone or created for one-off needs. As such, it is not absolutely necessary to follow a strict guideline for naming conventions for dashboards or reports. However, if your account has a large number of dashboards and reports or if your team shares dashboards and reports, you might benefit from using a naming convention that’s structured similarly to your naming convention for checks.
[Group] Purpose - Subtype (Label)
Group (optional): Prepend group names to the front of each report so that they can be easily sorted.
Eg. Sport, Media, eCommerce
Purpose: Define metrics or categories compared or included in the report.
Eg. Performance, Uptime, Size, Source vs Origin
Subtype (optional): Use subtypes to differentiate between similar reports.
Eg. Mobile/Desktop/Tablet, API/Uptime/Real Browser
Label (optional): Differentiate between multiple copies or versions of reports.
Eg. Test, Copy
When an account implements naming conventions for dashboards or custom reports it can make it easier to filter and sort by type:
While the naming conventions outlined above are popular among Rigor users, you and your team may have an entirely unique set of preferences or best practices. If you’re new to using Rigor you may want to check in with your group’s Admin user for recommendations on how to name your new check or report.