SLO annotation handling on the Nobl9 Web

Reading time: 0 minute(s) (0 words)

User annotations

User annotations are displayed on the SLO charts with the following icons:

• icon for user annotations with specified Start date

• icon for user annotations with specified Start date and the End date

Adding annotations

You can add annotations to your existing SLOs using the Nobl9 Web:

1. Go to Service Level Objectives in the main navigation panel.

2. In the SLO grid view, choose the SLO where you want to add your annotation and click it:

   

   Choosing a relevant time point in SLO to add annotation

   In the SLO details view, you can add annotations to:

   • The SLI chart.

   • The reliability burn-down chart.

   • The error budget burn rate chart.

3. Hover over any of the charts, choose a relevant time point on any of the above-mentioned charts, and click the chart to add annotation.

4. You will see a blue line and a pin icon which marks the annotation. In the pop-up window, provide the following information, that is, a description, specify the Start Date and End Date, and click the Add Annotation button.

   • The Start date and the End date fields will be pre-filled with the date of adding the annotation. You can change those values by clicking the Calendar icon.

   • If the Start date = End date, the annotation will be displayed as a single point in the chart.

   Adding annotation to the SLO

   • If the End date is later than the Start Date, the annotation will be displayed as a greyed-out area in your chart:

   Configuring Start and End date

   • Your added annotation will be displayed on every chart in SLO details.

   • You can add annotations in the overlapping timespans.

5. You will be able to see your annotations whenever you hover over them on any of the charts in the SLO details view:

   Displaying the added annotation

Deleting annotations

You can delete your annotations on the Nobl9 Web:

1. In the SLO details, hover over the annotation that you want to delete.

2. On the annotation details pop up, hover over the annotation that you want to delete.

3. Click the Trash icon, then click Delete to confirm:

Deleting an annotation

Managing system annotations

For each alerting or budget adjustment event in an SLO Nobl9 adds an annotation to the affected objective chart. Such annotation is displayed as a time range with startTime representing the timestamp of the event start and endTime representing the timestamp of the event resolution or cancel.

System annotations

System annotations don't depend on alert policy silence—Nobl9 creates the annotation for the silenced alert and displays it on the SLO charts anyway.

System annotations regarding alerts are created based on metric timestamp. Those annotations represent the time when an SLI indicates that alert was triggered or resolved. For the delayed metrics, Nobl9 will draw annotation in the past - note that it is not related to time when you receive a notification.

Image 1: Example of a system annotation for resolved alert

If an alert was triggered but not resolved yet, you can only see one annotation pin including only the startTime, not a time range.

You can show or hide all annotations displayed on the SLO details. You can choose whether to show system annotations, user-created annotations, or both. For this, do the following:

1. Open SLO details of your required SLO.
2. Click Settings > Annotations. Select the required annotations to show or hide.

Image 3: Show or hide annotations on the Nobl9 Web

Useful links

For a more in-depth look, consult additional resources:

The Nobl9 API for managing annotationsAPI