Reports in Nobl9
Reports in Nobl9 allow you to get data-driven insights into your service level objectives. With Nobl9 reports, you can resolve critical questions for your business: for instance, whether to focus on the development of new features or on managing your technical debt.
You can create custom reports besides displaying the ready-made Resource usage summary report.
You can also download the generated reports and share them with other users in your organization.
Report typesโ
The following types of reports are available in Nobl9:
The Resource Usage Summary report is ready-made and is always available in the Reports section.
SLO Historyโ
This report type allows you to check the performance of your SLOs. It is helpful for in-depth analyses of events and can be used by teams working in different time zones who want to see the same data in reports.
SLO History reports can be configured with two types of reporting time ranges:
- Rolling presents data according to the selected time range that dynamically moves as time progresses. For example, if you set the rolling time range to
1 month
, you will see data for the past 30 days up to the current time of the report opening. - Calendar-aligned range is tied to a specific range of time on the calendar with a clear start and stop date
Error Budget Statusโ
This report type gives you the percentage of errors in the selected time frame. It provides you with a quick and easy way to verify the statuses of SLOs. The Reliability column shows a reliability burn down rate for every SLO in the report.
Resource Usage Summaryโ
This report shows the number of resources and SLO units configured in Nobl9 and their peak usage.
An SLO unit represents the number of individual error budgets calculated by Nobl9. Each SLO contains at least one error budget, and every additional target set within an SLO adds another error budget. For instance, if a threshold metric has three targets, it amounts to three SLO units. In Nobl9 Web, each SLO unit appears as a separate tile on the SLO grid view.
See Nobl9 pricing for more details.
Since the Resource Usage Summary report is ready-made, its Reporting Time Range is always the current month.
Reliability Roll-upโ
This report allows Nobl9 users to gain a bird's-eye view of their Services' aggregated reliability over an extended period of time. Check Reliability Roll-up reports documentation for more details.
While Reliability Roll-up reports can seem similar to composite SLOs, they are two different tools to access the resource's performance.
- Reliability Roll-up report: Error budget
- Composite SLO: Burn rate
- Benefits
- โบ Flexible hierarchy. It means you can boil down many systems to a single number instead of sticking to the Nobl9 data model
- โบ Measures reliability as needed: by user journey, organization, team, application, etc.
- โบ Updated with labels
- โบ Easy to share
- Drawbacks
- โน Currently, reliability scores are updated daily at 00:00 UTC
- โน You must set alerts at the level of individual SLOs when necessary
- โน Focuses on SLO target adherence, not specific error budget numbers
- Benefits
- โบ Permanently available burn rate
- โบ Continuous composite error budget calculations providing a graphical representation
- Drawbacks
- โน Burn rates are evaluated in real time. It limits the number of signals included in a single composite
- โน Computationally intensive
Compares the burn rates for existing SLO objectives and marks the minutes bad
in the composite SLO when burn rates exceed your set threshold.
System Health Reviewโ
This report type is an accessible tool for reporting reliability and performance data.
The report indicates the service health based on the remaining error budget of SLOs it includes. Considering the error budget thresholds set for your organization's Service Health Dashboard, the following color-coded categories indicate your system health:
System Health Review can show current or historical health status. Historical reports can be one-time or recurring.
Learn more about System Health Review.
Creating reportsโ
You must have at least one service in Nobl9 to create a new custom report. While there are no services, is inactive, and report creation is locked.
At least one project is required to create a report. Once created, such a report displays no data:
You can add services and SLOs later. This populates your report with data (if the SLO reports any).
If there are more than 500 SLOs in your organization, you can experience downgraded performance, creating a report. Our team is currently working on fixing this issue.
To create a report, click . The Report wizard opens:
Follow the steps in the wizard. The number of steps depends on the report type. For example, Error Budget Status doesn't require Step 3 Select Time RangeโNobl9 always displays the current time ranges of selected SLOs for this type.
There are three main steps:
- Selecting the report type
- Defining the report scope
- Setting the report time range
Report name and type
- Report type.
Choose between the SLO History, Error Budget Status, Reliability Roll-up, and System Health Review:
- Specify the display name for your report.
- You can use any characters and spaces, up to 63.
The report's name
โa unique identifierโis generated automatically once the report is created. The name identifier is read-only. To view the report name, go to the report details and click View name next to its display name.
Report scope
Depending on the report type this step can be as follows:
-
Create reliability score layers for Reliability Roll-up.
-
Filter resources for all other reports
System Health ReviewTo define the scope for System Health Review, two more steps are required: Define report layout and Configure thresholds. Learn more about System Health Review reports.
Filtering resources defines the scope of your report. For this, fill out at least one of the following fields:
These fields are interconnected: once you choose resources in any of these fields, the results available in other fields narrow down. The dependency is project > service > SLO.
- Labels are optional and act as additional filters: the report will include resources marked with labels you specify here.
- If you create a report with no services and SLOs, the report will show no data. However, if a service with SLOs is added to that project later, the service with your SLOs will appear in your report.
- And vice-versa: if you build a report with services and SLOs and then remove SLOs from the service, the report will show no data.
Setting the time range
- This step isn't available for the Error Budget Status report since the time range for it is always a current time ranges of the SLOs selected.
- For the SLO History and Reliability Roll-up you can select between the Rolling and Calendar-aligned time windows.
Once these reports are created, you can move the time window to assess historical data. - System Health Review can be either real-time or retrospective.
You can create and edit your SLO History, Error Budget Status, and System Health Review reports using sloctl
.
For this,
apply a YAML definition for your required report type with the sloctl apply
command.
Viewing reportsโ
On the Nobl9 Web, go to the Reports section. You see the reports you created and those other users have shared with you.
Here you can create, view, and sort reports.
Click the required report in the list to view its details and access the available options.
Click | Action | Notes |
---|---|---|
Share | Share the report and copy the link to it | Available for report owners only |
A report is shared | Available for report owners only | |
Edit the report | The Report wizard opens | |
Delete the report | A permanent action | |
View name | View the report's name identifier | Read-only |
Download a CSV file with the report data | Available for Error Budget Status only | |
view yaml | View the YAML configuration | Available for System Health Review only |
The report summary can contain the following:
- Chart type: The Reliability burn down chart. Available for SLO History only.
- Created by: The first and last name of the person who created the report.
- Legend: Type codes and thresholds of the System Health Review report categories.
- Metric: Health by error budget remaining. Available for System Health Review only.
- Organization and tier name: Available for Resource Usage Summary only.
- Repeat: The recurrence rule for retrospective System Health Review.
- Report filters: The number of resources included in the report. In Reliability Roll-up: available only for the auto-generated structure.
- Reporting time: The time range the report reflects, including time zone. The time ranges can differ for users in different time zones to display the same data for all.
- Report type: Error Budget Status, Reliability Roll-up, Resource Usage Summary, SLO History, or System Health Review.
Role-based access and sharing reportsโ
The Resource Usage Summary report is always available for all users in an organization, except for the Organization responder users, regardless of their project role.
Organization admins have full access to all reports, regardless of project roles. They can view, create, edit, and delete any report.
All other reports, except for the Resource Usage Summary, are private by defaultโonly their owners can access them.
A report can be made accessible to other roles only if the owner shares it. The role-based access is as follows:
- Organization viewer:
- Without a project role
Can view only public reports. - With any project role
Can view all reports in the organization. Cannot create, edit, or delete reports. - With the Project owner or Project editor roles
Can create reports and edit or delete the reports they own.
- Without a project role
- Organization user and Organization responder:
- Without a project role
Require additional permissions to view, create, and edit reports. Cannot delete reports. - With the Project viewer, Project integrations viewer, Project responder roles
Can view reports they own. Report scope is limited to permitted projects. Cannot create, edit, or delete reports. - With the Project owner or Project editor roles
Can create reports and edit reports they own using SLOs from permitted projects. Can delete reports they own.
- Without a project role
If the report owner loses access to the report resources, they still can view this report in the report list.
The report's details will indicate that the user has limited access to its data. The report owner can share or delete the report but cannot edit it.
To share a report, do the following:
- Go to the Reports section on the Nobl9 Web.
- Click (Share) in the required report's header.
Available for report owners only.
The dialog with user and access type settings opens.
- Click Share.
As a result, the report is indicated as shared
Users with permissions to the projects included in your report gain access to it, based on their organization and project roles.
To revoke access to the report, do the following:
- Click (Shared) in the required report header.
- Select All with access to included projects > Remove access.
Report sharing is based on current user permissions and applies regardless of when permissions were granted.