Skip to content

Commit

Permalink
Resolve merge conflicts
Browse files Browse the repository at this point in the history
  • Loading branch information
@estherk15
estherk15 committed Dec 13, 2023
2 parents 36c20d3 + efc364f commit 24d2e8e
Show file tree
Hide file tree
Showing 2 changed files with 40 additions and 42 deletions.
78 changes: 39 additions & 39 deletions content/en/service_management/service_level_objectives/_index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -67,11 +67,11 @@ Use Datadog's [Service Level Objectives status page][2] to create new SLOs or to
### Configuration

1. On the [SLO status page][2], select **New SLO +**.
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][50].
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].
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. If you configure more than one time window, select one to be the primary time window. This time window is displayed on SLO lists. By default, the shortest time window is selected.
4. Finally, give the SLO a title, describe it in more detail or add links in the description, add tags, and save it.

After you set up the SLO, select it from the [Service Level Objectives list view][2] to open the details side panel. The side panel displays the overall status percentage and remaining error budget for each of the SLO's targets, as well as status bars (monitor-based SLOs) or bar graphs (metric-based SLOs) of the SLI's history. If you created a grouped monitor-based SLO using one [multi alert monitor][5] or a grouped metric-based SLO using the [`sum by` clause][6], the status percentage and remaining error budget for each individual group is displayed in addition to the overall status percentage and remaining error budget.
After you set up the SLO, select it from the [Service Level Objectives list view][2] to open the details side panel. The side panel displays the overall status percentage and remaining error budget for each of the SLO's targets, as well as status bars (monitor-based SLOs) or bar graphs (metric-based SLOs) of the SLI's history. If you created a grouped monitor-based SLO using one [multi alert monitor][6] or a grouped metric-based SLO using the [`sum by` clause][7], the status percentage and remaining error budget for each individual group is displayed in addition to the overall status percentage and remaining error budget.

Check notice on line 74 in content/en/service_management/service_level_objectives/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/en/service_management/service_level_objectives/_index.md#L74 

[Datadog.sentencelength] Try to keep your sentence length to 25 words or fewer.
Raw output 
{"message": "[Datadog.sentencelength] Try to keep your sentence length to 25 words or fewer.", "location": {"path": "content/en/service_management/service_level_objectives/_index.md", "range": {"start": {"line": 74, "column": 118}}}, "severity": "INFO"}

Check notice on line 74 in content/en/service_management/service_level_objectives/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/en/service_management/service_level_objectives/_index.md#L74 

[Datadog.sentencelength] Try to keep your sentence length to 25 words or fewer.
Raw output 
{"message": "[Datadog.sentencelength] Try to keep your sentence length to 25 words or fewer.", "location": {"path": "content/en/service_management/service_level_objectives/_index.md", "range": {"start": {"line": 74, "column": 330}}}, "severity": "INFO"}

**Example:** If you create a monitor-based SLO to track latency per availability-zone, the status percentages and remaining error budget for the overall SLO and for each individual availability-zone that the SLO is tracking are displayed.

Expand All @@ -87,9 +87,9 @@ Setting a 100% target means having an error budget of 0% since error budget is e

**Note:** The number of decimal places you can specify for your SLOs differs depending on the type of SLO and the time windows you choose. Refer to the links below for more information for each respective SLO type.

[Monitor-based SLOs][7]: Up to two decimal places are allowed for 7-day and 30-day targets, up to three decimal places are allowed for 90-day targets.
[Monitor-based SLOs][8]: Up to two decimal places are allowed for 7-day and 30-day targets, up to three decimal places are allowed for 90-day targets.

Check notice on line 90 in content/en/service_management/service_level_objectives/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/en/service_management/service_level_objectives/_index.md#L90 

[Datadog.sentencelength] Try to keep your sentence length to 25 words or fewer.
Raw output 
{"message": "[Datadog.sentencelength] Try to keep your sentence length to 25 words or fewer.", "location": {"path": "content/en/service_management/service_level_objectives/_index.md", "range": {"start": {"line": 90, "column": 2}}}, "severity": "INFO"}

[Metric-based SLOs][8]: Up to three decimal places are allowed for all targets.
[Metric-based SLOs][9]: Up to three decimal places are allowed for all targets.

## Edit an SLO

Expand All @@ -99,13 +99,13 @@ To edit an SLO, hover over the SLO's row in the list view and click the edit pen

### Role based access

All users can view SLOs and [SLO status corrections](#slo-status-corrections), regardless of their associated [role][9]. Only users attached to roles with the `slos_write` permission can create, edit, and delete SLOs.
All users can view SLOs and [SLO status corrections](#slo-status-corrections), regardless of their associated [role][10]. Only users attached to roles with the `slos_write` permission can create, edit, and delete SLOs.

To create, edit, and delete status corrections, users require the `slos_corrections` permissions. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs. For the full list of permissions, see the [RBAC documentation][10].
To create, edit, and delete status corrections, users require the `slos_corrections` permissions. A user with this permission can make status corrections, even if they do not have permission to edit those SLOs. For the full list of permissions, see the [RBAC documentation][11].

### Granular access controls

Restrict access to individual SLOs by specifying a list of [roles][9] that are allowed to edit it.
Restrict access to individual SLOs by specifying a list of [roles][10] that are allowed to edit it.

{{< img src="service_management/service_level_objectives/slo_set_permissions.png" style="width:100%; background:none; border:none; box-shadow:none;" alt="SLO permissions option in the cog menu">}}

Expand All @@ -121,7 +121,7 @@ Restrict access to individual SLOs by specifying a list of [roles][9] that are a

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.

**Note**: Users can create SLOs on any monitor even if they do not have write permissions to the monitor. Similarly, users can create SLO alerts even if they do not have write permissions to the SLO. For more information on RBAC permissions for Monitors, see the [RBAC documentation][11] or the [guide on how to set up RBAC for Monitors][12].
**Note**: Users can create SLOs on any monitor even if they do not have write permissions to the monitor. Similarly, users can create SLO alerts even if they do not have write permissions to the SLO. For more information on RBAC permissions for Monitors, see the [RBAC documentation][12] or the [guide on how to set up RBAC for Monitors][13].

## Searching SLOs

Expand All @@ -145,15 +145,15 @@ Group your SLOs by *team*, *service* or *environment* to get a summary view of y

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.

**Note**: You can view your SLOs from your mobile device home screen by downloading the [Datadog Mobile App][13], available on the [Apple App Store][14] and [Google Play Store][15].
**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].

Check notice on line 148 in content/en/service_management/service_level_objectives/_index.md

View workflow job for this annotation

GitHub Actions / vale

[vale] content/en/service_management/service_level_objectives/_index.md#L148 

[Datadog.sentencelength] Try to keep your sentence length to 25 words or fewer.
Raw output 
{"message": "[Datadog.sentencelength] Try to keep your sentence length to 25 words or fewer.", "location": {"path": "content/en/service_management/service_level_objectives/_index.md", "range": {"start": {"line": 148, "column": 3}}}, "severity": "INFO"}

{{< img src="service_management/service_level_objectives/slos-mobile.png" style="width:100%; background:none; border:none; box-shadow:none;" alt="SLOs on iOS and Android">}}

### SLO tags

When you create or edit an SLO, you can add tags for filtering on the [SLO status page][2] or for creating [SLO saved views][16].
When you create or edit an SLO, you can add tags for filtering on the [SLO status page][2] or for creating [SLO saved views][17].

Add tags to SLOs in bulk with the *Edit Tags* and the *[Edit Teams][17]* dropdown options at the top of the SLO list.
Add tags to SLOs in bulk with the *Edit Tags* and the *[Edit Teams][18]* dropdown options at the top of the SLO list.

### SLO default view

Expand Down Expand Up @@ -213,7 +213,7 @@ Three types of SLO audit events appear in the Event Explorer:

To get a full list of all SLO audit events, enter the search query `tags:audit,slo` in the Event Explorer. To view the list of audit events for a specific SLO, enter `tags:audit,slo_id:<SLO ID>` with the ID of the desired SLO.

You can also query the Event Explorer programmatically using the [Datadog Events API][18].
You can also query the Event Explorer programmatically using the [Datadog Events API][19].

**Note:** If you don't see events appear in the UI, be sure to set the time frame of the Event Explorer to a longer period, for example, the past 7 days.

Expand All @@ -228,11 +228,11 @@ For example, if you wish to be notified when a specific SLO's configuration is m
After creating your SLO, you can visualize the data through Dashboards and widgets.
- Use the SLO Summary widget to visualize the status of a single SLO.
- Use the SLO List widget to visualize a set of SLOs
- Graph 15 months' worth of metric-based SLO data with the [SLO data source][19] in both timeseries and scalar (query value, top list, table, change) widgets.
- Graph 15 months' worth of metric-based SLO data with the [SLO data source][20] in both timeseries and scalar (query value, top list, table, change) widgets.

For more information about SLO Widgets, see the [SLO Summary][20] and [SLO List][21] widget pages. For more information on the SLO data source, see the guide on how to [Graph historical SLO data on Dashboards][19].
For more information about SLO Widgets, see the [SLO Summary][21] and [SLO List][22] widget pages. For more information on the SLO data source, see the guide on how to [Graph historical SLO data on Dashboards][20].

To proactively manage the configurations of your SLOs, set an [Event Monitor][22] to notify you when events corresponding to certain tags occur.
To proactively manage the configurations of your SLOs, set an [Event Monitor][23] to notify you when events corresponding to certain tags occur.

## SLO status corrections

Expand All @@ -246,7 +246,7 @@ When you apply a correction, the time period you specify is dropped from the SLO
- For metric-based SLOs, all good and bad events in the correction window are not counted.
- For Time Slice SLOs, the correction time window is treated as uptime.

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][23]. 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.
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.

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.

Expand All @@ -263,7 +263,7 @@ The 90-day limits per SLO are as follows:
| Weekly recurring | 3 |
| Monthly recurring | 5 |

You may configure status corrections through the UI by selecting `Correct Status` in your SLO's side panel, the [SLO status corrections API][24], or a [Terraform resource][25].
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].

{{< img src="service_management/service_level_objectives/slo-corrections-ui.png" alt="SLO correction UI" >}}

Expand All @@ -289,25 +289,25 @@ To view, edit, and delete existing status corrections, click on the **Correction
[2]: https://app.datadoghq.com/slo
[3]: /service_management/service_level_objectives/metric/
[4]: /service_management/service_level_objectives/monitor/
[5]: /monitors/types/metric/?tab=threshold#alert-grouping
[6]: /service_management/service_level_objectives/metric/#define-queries
[7]: /service_management/service_level_objectives/monitor/#set-your-slo-targets
[8]: /service_management/service_level_objectives/metric/#set-your-slo-targets
[9]: /account_management/rbac/
[10]: /account_management/rbac/permissions/#service-level-objectives/
[11]: /account_management/rbac/permissions/#monitors
[12]: /monitors/guide/how-to-set-up-rbac-for-monitors/
[13]: /mobile
[14]: https://apps.apple.com/app/datadog/id1391380318
[15]: https://play.google.com/store/apps/details?id=com.datadog.app
[16]: /service_management/service_level_objectives/#saved-views
[17]: /account_management/teams/#associate-resources-with-team-handles
[18]: /api/latest/events/
[19]: /dashboards/guide/slo_data_source/
[20]: /dashboards/widgets/slo/
[21]: /dashboards/widgets/slo_list/
[22]: /monitors/types/event/
[23]: https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html
[24]: /api/latest/service-level-objective-corrections/
[25]: https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/slo_correction
[50]: /service_management/service_level_objectives/time_slice/
[5]: /service_management/service_level_objectives/time_slice/
[6]: /monitors/types/metric/?tab=threshold#alert-grouping
[7]: /service_management/service_level_objectives/metric/#define-queries
[8]: /service_management/service_level_objectives/monitor/#set-your-slo-targets
[9]: /service_management/service_level_objectives/metric/#set-your-slo-targets
[10]: /account_management/rbac/
[11]: /account_management/rbac/permissions/#service-level-objectives/
[12]: /account_management/rbac/permissions/#monitors
[13]: /monitors/guide/how-to-set-up-rbac-for-monitors/
[14]: /mobile
[15]: https://apps.apple.com/app/datadog/id1391380318
[16]: https://play.google.com/store/apps/details?id=com.datadog.app
[17]: /service_management/service_level_objectives/#saved-views
[18]: /account_management/teams/#associate-resources-with-team-handles
[19]: /api/latest/events/
[20]: /dashboards/guide/slo_data_source/
[21]: /dashboards/widgets/slo/
[22]: /dashboards/widgets/slo_list/
[23]: /monitors/types/event/
[24]: https://icalendar.org/iCalendar-RFC-5545/3-8-5-3-recurrence-rule.html
[25]: /api/latest/service-level-objective-corrections/
[26]: https://registry.terraform.io/providers/DataDog/datadog/latest/docs/resources/slo_correction
4 changes: 1 addition & 3 deletions ...nt/en/service_management/service_level_objectives/guide/slo_types_comparison.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,7 @@ When creating SLOs, you can choose from the following types:
| [**Uptime Calculations**][7] | N/A | Uptime is calculated by looking at discrete time chunks, not rolling time windows<br><br>If groups are present, overall uptime requires *all* groups to have uptime | Uptime calculations are based on the underlying Monitor <br><br>If groups are present, overall uptime requires *all* groups to have uptime|
| **Calendar View on SLO Manage Page** | Available | Not available | Available |



## Further reading
## Further Reading

{{< partial name="whats-next/whats-next.html" >}}

Expand Down

0 comments on commit 24d2e8e

Please sign in to comment.