Skip to content

Commit 67b6636

Browse files
authored
semantic tagging for slos, session replay, sheets, source code, tests, usm, watchdog (#37775)
1 parent 00048f7 commit 67b6636

47 files changed

Lines changed: 353 additions & 353 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

content/en/service_level_objectives/_index.md

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ Use Datadog's [Service Level Objectives manage page][2] to create new SLOs or to
8080

8181
### Configuration
8282

83-
1. On the [SLO manage page][2], select **New SLO +**.
83+
1. On the [SLO manage page][2], select {{< ui >}}New SLO +{{< /ui >}}.
8484
2. Select the SLO type. You can create an SLO with any of the following types: [Metric-based][3], [Monitor-based][4], or [Time Slices][5].
8585
3. Set a target and a rolling time window (past 7, 30, or 90 days) for the SLO. Datadog recommends you make the target stricter than your stipulated SLAs. This time window is displayed on SLO lists. By default, the shortest time window is selected.
8686
4. Finally, give the SLO a title, describe it in more detail or add links in the description, add tags, and save it.
@@ -125,13 +125,13 @@ Restrict access to individual SLOs by specifying a list of [roles][10] that are
125125

126126
1. Click on the SLO to open the details side panel.
127127
1. Click the cog icon in the upper right of the panel.
128-
1. Select **Permissions**.
129-
1. Click **Restrict Access**.
130-
1. The dialog box updates to show that members of your organization have **Viewer** access by default.
128+
1. Select {{< ui >}}Permissions{{< /ui >}}.
129+
1. Click {{< ui >}}Restrict Access{{< /ui >}}.
130+
1. The dialog box updates to show that members of your organization have {{< ui >}}Viewer{{< /ui >}} access by default.
131131
1. Use the drop-down to select one or more roles, teams, or users that may edit the SLO.
132-
1. Click **Add**.
133-
1. The dialog box updates to show that the role you selected has the **Editor** permission.
134-
1. Click **Save**
132+
1. Click {{< ui >}}Add{{< /ui >}}.
133+
1. The dialog box updates to show that the role you selected has the {{< ui >}}Editor{{< /ui >}} permission.
134+
1. Click {{< ui >}}Save{{< /ui >}}
135135

136136
To maintain your edit access to the SLO, the system requires you to include at least one role that you are a member of before saving. Users on the access control list can add roles and can only remove roles other than their own.
137137

@@ -157,7 +157,7 @@ Group your SLOs by *any* tag to get a summary view of your data. You can quickly
157157

158158
{{< img src="service_management/service_level_objectives/slo_group_by_new.png" alt="Summary view of SLOs grouped by Team" style="width:100%;" >}}
159159

160-
Sort SLOs by the *status* and *error budget* columns to prioritize which SLOs need your attention. The SLO list displays the details of SLOs over the primary time window selected in your [configuration](#configuration). All other configuration time windows are available to view in the individual side panel. Open the SLO details side panel by clicking the respective table row.
160+
Sort SLOs by the {{< ui >}}status{{< /ui >}} and {{< ui >}}error budget{{< /ui >}} columns to prioritize which SLOs need your attention. The SLO list displays the details of SLOs over the primary time window selected in your [configuration](#configuration). All other configuration time windows are available to view in the individual side panel. Open the SLO details side panel by clicking the respective table row.
161161

162162
**Note**: You can view your SLOs from your mobile device home screen by downloading the [Datadog Mobile App][14], available on the [Apple App Store][15] and [Google Play Store][16].
163163

@@ -168,7 +168,7 @@ Sort SLOs by the *status* and *error budget* columns to prioritize which SLOs ne
168168
SLO tags can be used for filtering on the [SLO manage page][2], creating [SLO saved views][17], or grouping SLOs to view. Tags can be added to SLOs in the following ways:
169169

170170
- When you create or edit an SLO, you can add tags
171-
- From the SLO list view, you can add and update tags in bulk using the *Edit Tags* and the *[Edit Teams][18]* dropdown options at the top of the SLO list.
171+
- From the SLO list view, you can add and update tags in bulk using the {{< ui >}}Edit Tags{{< /ui >}} and the [{{< ui >}}Edit Teams{{< /ui >}}][18] dropdown options at the top of the SLO list.
172172

173173
{{< img src="service_management/service_level_objectives/slo_bulk_tag.png" alt="SLO list page displays the Edit Tag dropdown for bulk tag editing" >}}
174174

@@ -210,24 +210,24 @@ After you query for a subset of SLOs on the list view, you can add that query as
210210
To add a saved view:
211211

212212
1. Query for your SLOs.
213-
2. Click **Save View +** at the top left of the page.
213+
2. Click {{< ui >}}Save View +{{< /ui >}} at the top left of the page.
214214
3. Name your view and save.
215215

216216
#### Load a saved view
217217

218-
To load a saved view, open the *Saved Views* panel by pressing the **Show Views** button at the top left of the page and select a saved view from the list. You can also search for saved views in the *Filter Saved Views* search box at the top of that same *Saved Views* panel.
218+
To load a saved view, open the {{< ui >}}Saved Views{{< /ui >}} panel by pressing the {{< ui >}}Show Views{{< /ui >}} button at the top left of the page and select a saved view from the list. You can also search for saved views in the {{< ui >}}Filter Saved Views{{< /ui >}} search box at the top of that same {{< ui >}}Saved Views{{< /ui >}} panel.
219219

220220
#### Share a saved view
221221

222222
Hover over a saved view from the list and select the hyperlink icon to copy the link to the saved view to share it with your teammates.
223223

224224
#### Manage saved views
225225

226-
Once you are using a saved view, you can update it by selecting that saved view, modifying the query, and clicking the *Update* button below its name in the *Saved Views* panel. To change the saved view's name or delete a saved view, hover over its row in the *Saved Views* panel and click the pencil icon or trash can icon, respectively.
226+
Once you are using a saved view, you can update it by selecting that saved view, modifying the query, and clicking the {{< ui >}}Update{{< /ui >}} button below its name in the {{< ui >}}Saved Views{{< /ui >}} panel. To change the saved view's name or delete a saved view, hover over its row in the {{< ui >}}Saved Views{{< /ui >}} panel and click the pencil icon or trash can icon, respectively.
227227

228228
## SLO and SLO status correction audit events
229229

230-
SLO audit events allow you to track the history of your SLO configurations using the [Event Explorer][27] or the **Audit History** tab in the SLO details. Audit events are added to the Event Explorer every time you create, modify, or delete an SLO or SLO status correction. Each event includes information on the configuration of an SLO or SLO status correction, and the stream provides a history of the configuration changes over time.
230+
SLO audit events allow you to track the history of your SLO configurations using the [Event Explorer][27] or the {{< ui >}}Audit History{{< /ui >}} tab in the SLO details. Audit events are added to the Event Explorer every time you create, modify, or delete an SLO or SLO status correction. Each event includes information on the configuration of an SLO or SLO status correction, and the stream provides a history of the configuration changes over time.
231231

232232
### SLO audit events
233233

@@ -264,7 +264,7 @@ To get a full list of all SLO audit events, enter the search query `tags:(audit
264264

265265
{{< img src="service_management/service_level_objectives/slo-audit-events.png" alt="SLO audit events" >}}
266266

267-
You can also use the "Audit History" tab in the SLO details to view all audit events for an individual SLO:
267+
You can also use the {{< ui >}}Audit History{{< /ui >}} tab in the SLO details to view all audit events for an individual SLO:
268268

269269
{{< img src="service_management/service_level_objectives/slo_audit_history_tab.png" alt="SLO details audit history tab" >}}
270270

@@ -297,7 +297,7 @@ When you apply a correction, the time period you specify is dropped from the SLO
297297

298298
You have the option to create one-time corrections for ad hoc adjustments, or recurring corrections for predictable adjustments that occur on a regular cadence. One-time corrections require a start and end time, while recurring corrections require a start time, duration, and interval. Recurring corrections are based on [iCalendar RFC 5545's RRULE specification][24]. The supported rules are `FREQ`, `INTERVAL`, `COUNT`, and `UNTIL`. Specifying an end date for recurring corrections is optional in case you need the correction to repeat indefinitely.
299299

300-
For either type of correction, you must select a correction category that states why the correction is being made. The available categories are `Scheduled Maintenance`, `Outside Business Hours`, `Deployment`, and `Other`. You can optionally include a description to provide additional context if necessary.
300+
For either type of correction, you must select a correction category that states why the correction is being made. The available categories are {{< ui >}}Scheduled Maintenance{{< /ui >}}, {{< ui >}}Outside Business Hours{{< /ui >}}, {{< ui >}}Deployment{{< /ui >}}, and {{< ui >}}Other{{< /ui >}}. You can optionally include a description to provide additional context if necessary.
301301

302302
Each SLO has a maximum limit of corrections that can be configured to ensure query performance. These limits only apply to the past 90 days per SLO, so corrections for time periods before the past 90 days do not count towards your limit. This means that:
303303
- If the end time of a one-time correction is before the past 90 days, it does count towards your limit.
@@ -312,33 +312,33 @@ The 90-day limits per SLO are as follows:
312312
| Weekly recurring | 3 |
313313
| Monthly recurring | 5 |
314314

315-
You may configure status corrections through the UI by selecting `Correct Status` in your SLO's side panel, the [SLO status corrections API][25], or a [Terraform resource][26].
315+
You may configure status corrections through the UI by selecting {{< ui >}}Correct Status{{< /ui >}} in your SLO's side panel, the [SLO status corrections API][25], or a [Terraform resource][26].
316316

317317
#### Access in the UI
318318

319319
To access SLO status corrections in the UI:
320320

321321
1. Create a new SLO or click on an existing one.
322322
2. Navigate to an SLO's details side panel view.
323-
3. Under the gear icon, select **Correct Status** to access the **Status Corrections** creation modal.
324-
4. Choose between `One-Time` and `Recurring` in the **Select the Time Correction Window**, and specify the time period you wish to correct.
325-
5. Select a **Correction Type**.
326-
6. Optionally add **Notes**.
327-
7. Click **Apply Correction**.
323+
3. Under the gear icon, select {{< ui >}}Correct Status{{< /ui >}} to access the {{< ui >}}Status Corrections{{< /ui >}} creation modal.
324+
4. Choose between {{< ui >}}One-Time{{< /ui >}} and {{< ui >}}Recurring{{< /ui >}} in the {{< ui >}}Select the Time Correction Window{{< /ui >}}, and specify the time period you wish to correct.
325+
5. Select a {{< ui >}}Correction Type{{< /ui >}}.
326+
6. Optionally add {{< ui >}}Notes{{< /ui >}}.
327+
7. Click {{< ui >}}Apply Correction{{< /ui >}}.
328328

329329
{{< img src="service_management/service_level_objectives/slo-corrections-ui.png" alt="SLO correction UI" style="width:80%;">}}
330330

331-
To view, edit, and delete existing status corrections, click on the **Corrections** tab at the top of an SLO's detailed side panel view.
331+
To view, edit, and delete existing status corrections, click on the {{< ui >}}Corrections{{< /ui >}} tab at the top of an SLO's detailed side panel view.
332332

333333
#### Visualizing status corrections
334334

335-
For Metric-based and Time Slice SLOs with status corrections, there is a toggle in the SLO detail view that lets you enable or disable corrections in the UI. The toggle controls the charts and data in the "History" section of the SLO detail view. **Note:** Your overall SLO status and error budget will always take status corrections into consideration.
335+
For Metric-based and Time Slice SLOs with status corrections, there is a toggle in the SLO detail view that lets you enable or disable corrections in the UI. The toggle controls the charts and data in the {{< ui >}}History{{< /ui >}} section of the SLO detail view. **Note:** Your overall SLO status and error budget will always take status corrections into consideration.
336336

337337
{{< img src="service_management/service_level_objectives/correction-toggle.png" alt="SLO correction UI" style="width:100%;">}}
338338

339339
## SLO calendar view
340340

341-
The SLO Calendar View is available on the [SLO manage page][2]. On the top right corner, switch from the "Primary" view to the "Daily", "Weekly", or "Monthly" view to see 12 months of historical SLO status data. The Calendar View is supported for Metric-based SLOs and Time Slice SLOs.
341+
The SLO Calendar View is available on the [SLO manage page][2]. On the top right corner, switch from the {{< ui >}}Primary{{< /ui >}} view to the {{< ui >}}Daily{{< /ui >}}, {{< ui >}}Weekly{{< /ui >}}, or {{< ui >}}Monthly{{< /ui >}} view to see 12 months of historical SLO status data. The Calendar View is supported for Metric-based SLOs and Time Slice SLOs.
342342

343343
{{< img src="service_management/service_level_objectives/slo-calendar-view-2.png" alt="SLO calendar view" >}}
344344

content/en/service_level_objectives/burn_rate.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -96,16 +96,16 @@ $$\text"burn rate" = {7 \text"days" * 24 \text"hours" * 10% \text"error budget c
9696
## Monitor creation
9797

9898
1. Navigate to the [SLO status page][4].
99-
2. Create a new SLO or edit an existing one, then click the **Save and Set Alert** button. For existing SLOs, you can also click the **Set up Alerts** button in the SLO detail side panel to take you directly to the alert configuration.
100-
3. Select the **Burn Rate** tab in **Step 1: Setting alerting conditions**
99+
2. Create a new SLO or edit an existing one, then click the {{< ui >}}Save and Set Alert{{< /ui >}} button. For existing SLOs, you can also click the {{< ui >}}Set up Alerts{{< /ui >}} button in the SLO detail side panel to take you directly to the alert configuration.
100+
3. Select the {{< ui >}}Burn Rate{{< /ui >}} tab in {{< ui >}}Step 1: Setting alerting conditions{{< /ui >}}
101101
4. Set an alert to trigger when a certain burn rate is measured during a specific long window:
102102
* The burn rate value must be in the range of
103103
$$0 < \text"burn rate" ≤ 1 / {1 - \text"SLO target"}$$
104104
* Datadog supports a maximum value of 48 hours for the long window. Your long window must be in the range of `1 hour <= long window <= 48 hours`.
105105
* The short window is then automatically calculated in the UI as `short window = 1/12 * long window`.
106106
* You can specify a different short window value using the [API or Terraform](#api-and-terraform), but it must always be less than the long window.
107-
5. Add [Notification information][4] into the **Configure notifications and automations** section.
108-
6. Click the **Save and Exit** button on the SLO configuration page.
107+
5. Add [Notification information][4] into the {{< ui >}}Configure notifications and automations{{< /ui >}} section.
108+
6. Click the {{< ui >}}Save and Exit{{< /ui >}} button on the SLO configuration page.
109109

110110
### Alerting for SLOs with groups
111111

content/en/service_level_objectives/error_budget.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,12 @@ For a description of key terminology around SLOs, including *error budgets*, see
3131
## Monitor creation
3232

3333
1. Navigate to the [SLO status page][4].
34-
2. Create a new SLO or edit an existing one, then click the **Save and Set Alert** button. For existing SLOs, you can also click the **Set up Alerts** button in the SLO detail side panel to take you directly to the alert configuration.
35-
3. Select the **Error Budget** tab in **Step 1: Setting alerting conditions**.
34+
2. Create a new SLO or edit an existing one, then click the {{< ui >}}Save and Set Alert{{< /ui >}} button. For existing SLOs, you can also click the {{< ui >}}Set up Alerts{{< /ui >}} button in the SLO detail side panel to take you directly to the alert configuration.
35+
3. Select the {{< ui >}}Error Budget{{< /ui >}} tab in {{< ui >}}Step 1: Setting alerting conditions{{< /ui >}}.
3636
4. Set an alert to trigger when the percentage of the error budget consumed is above the `threshold`.
3737
over the past `target` number of days.
38-
4. Add [Notification information][5] in the **Configure notifications and automations** section.
39-
5. Click the **Create & Set Alert** button on the SLO configuration page.
38+
4. Add [Notification information][5] in the {{< ui >}}Configure notifications and automations{{< /ui >}} section.
39+
5. Click the {{< ui >}}Create & Set Alert{{< /ui >}} button on the SLO configuration page.
4040

4141
{{< img src="service_management/service_level_objectives/slo_create_set_alert.png" alt="Create SLO and set up an error budget alert" style="width:80%;">}}
4242

content/en/service_level_objectives/metric.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@ Metric-based SLOs are useful for a count-based stream of data where you are diff
2929

3030
## Setup
3131

32-
On the [SLO status page][5], click **+ New SLO**. Then select, [**By Count**][6].
32+
On the [SLO status page][5], click {{< ui >}}+ New SLO{{< /ui >}}. Then select, [{{< ui >}}By Count{{< /ui >}}][6].
3333

3434
### Define queries
3535

36-
1. There are two queries to define: **Sum of the good events** and **Sum of the bad events**. <br>These are used to calculate the SLI, which is defined as the ratio of good events to the number of good and bad events combined.<br> <div class="alert alert-danger">Total events queries are a legacy SLO definition. While you can modify SLOs that use total events through the UI and API, to create a total events query, you must use the API. </div>
36+
1. There are two queries to define: {{< ui >}}Sum of the good events{{< /ui >}} and {{< ui >}}Sum of the bad events{{< /ui >}}. <br>These are used to calculate the SLI, which is defined as the ratio of good events to the number of good and bad events combined.<br> <div class="alert alert-danger">Total events queries are a legacy SLO definition. While you can modify SLOs that use total events through the UI and API, to create a total events query, you must use the API. </div>
3737
Your queries must use COUNT, RATE, or percentile-enabled DISTRIBUTION metrics to ensure the SLO calculation behaves correctly. For more information, see [Querying][9].
38-
1. Use the `FROM` field to include or exclude specific groups using tags.
38+
1. Use the {{< ui >}}FROM{{< /ui >}} field to include or exclude specific groups using tags.
3939
1. For percentile-enabled DISTRIBUTION metrics, you must use the `count values...` aggregator to specify a numerical threshold for the metric to count. This feature is called Threshold Queries and allows you to count the number of raw values that match a numerical threshold to produce counts for your numerator and denominator. For more information, see [Threshold Queries][7].
4040
1. Optionally, for percentile-enabled DISTRIBUTION metrics, use the dropdown immediately to the right of the `count values..` aggregator to break your SLI out by specific groups.
4141
1. Optionally, for COUNT or RATE metrics, use the `sum by` aggregator to break your SLI out by specific groups.

content/en/service_level_objectives/monitor.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Datadog monitor-based SLOs support the following monitor types:
3838

3939
## Setup
4040

41-
On the [SLO status page][2], click **+ New SLO**. Then, select **By Monitor Uptime**.
41+
On the [SLO status page][2], click {{< ui >}}+ New SLO{{< /ui >}}. Then, select {{< ui >}}By Monitor Uptime{{< /ui >}}.
4242

4343
### Define queries
4444

@@ -52,7 +52,7 @@ In the search box, start typing the name of a monitor. A list of matching monito
5252

5353
### Set your SLO targets
5454

55-
Select a **target** percentage, **time window**, and optional **warning** level.
55+
Select a {{< ui >}}target{{< /ui >}} percentage, {{< ui >}}time window{{< /ui >}}, and optional {{< ui >}}warning{{< /ui >}} level.
5656

5757
The target percentage specifies the portion of time the underlying monitor(s) of the SLO should not be in the ALERT state. The time window specifies the rolling period the SLO runs its calculation.
5858

@@ -73,7 +73,7 @@ If you need finer granularity than the once a minute monitor evaluation, conside
7373

7474
### Add name and tags
7575

76-
Choose a name and extended description for your SLO. Select any tags you would like to associate with your SLO. Select **Create** or **Create & Set Alert** to save your new SLO.
76+
Choose a name and extended description for your SLO. Select any tags you would like to associate with your SLO. Select {{< ui >}}Create{{< /ui >}} or {{< ui >}}Create & Set Alert{{< /ui >}} to save your new SLO.
7777

7878
## Status calculation
7979

0 commit comments

Comments
 (0)