-
Notifications
You must be signed in to change notification settings - Fork 1.2k
DOCS-10584 #28791
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
DOCS-10584 #28791
Changes from all commits
Commits
Show all changes
43 commits
Select commit
Hold shift + click to select a range
501c85d
add Eng Reports pages with initial text and add to menu
domalessi fc77763
small refinements
domalessi 6588a37
create shortcode for summary score
domalessi 79225fc
add shortcode for customizing DB
domalessi 8bfec7e
undo the shortcodes ugh
domalessi e745f75
keep summary score shortcoe and just copy content with minor tweaks f…
domalessi 3f94d77
update scorecards perf page, create shortcode for customize details a…
domalessi fec93fc
add scheduled reports link
domalessi 5c68113
Merge branch 'master' into domalessi/docs-10584
domalessi f7d1719
update content for interacting with reliability overview report
domalessi 461075d
update content for scorecards perf page
domalessi 9b662e1
add overview pages doc
domalessi 16b13a8
starting work on overview pages
domalessi 202d2ad
flesh out and refine copy on overview page
domalessi a98fafb
add overview page to toc
domalessi e97e869
more refinemenets
domalessi 1b3c13c
update toc
domalessi 7668443
add videos for eng reports
domalessi a783a8e
initial editing per feedback from pm on overview page
domalessi 818508b
Overview page edits
domalessi 4082517
additional overview page updates
domalessi 01dcc55
address PR feedback and delete OOTB DBs page
domalessi 3f5c587
update SLO tocx
domalessi 771e5b7
remove summary score shortcode and add content to Reliabilitiy Overvi…
domalessi 1689a30
delete eng reports dupe page from SLO section
domalessi f75fa88
minor language tweak
domalessi abd610c
adjust verb tense in titles
domalessi 86aa2e1
update images for eng reports
domalessi 6805779
adjust images
domalessi c582997
a few more photo updates
domalessi d5d9272
address PR feedback
domalessi bab6d43
remove customize reports shortcode
domalessi b79735b
update image
domalessi f71bc83
Merge branch 'master' into domalessi/docs-10584
domalessi 906f8d2
update further reading sections
domalessi 33c68fa
Merge branch 'domalessi/docs-10584' of github.com:DataDog/documentati…
domalessi 4e7d671
address PR feedback and add preview sign up forms
domalessi 7db1478
add formula
domalessi 0ae1c50
incorporate PR feedback
domalessi 8ee1f3a
minor tweaks
domalessi 58eab6e
update images and add the correct preview forms
domalessi 052bf83
Apply suggestions from code review
domalessi 0206fee
Apply suggestions from code review
domalessi File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
--- | ||
title: Engineering Reports | ||
further_reading: | ||
- link: "/service_management/service_level_objectives/" | ||
tag: "Documentation" | ||
text: "Service Level Objectives" | ||
- link: "service_management/incident_management/" | ||
tag: "Documentation" | ||
text: "Incident Management" | ||
- link: "software_catalog/scorecards/" | ||
tag: "Documentation" | ||
text: "Datadog Scorecards" | ||
--- | ||
|
||
{{< callout url="https://www.datadoghq.com/product-preview/engineering-reports/" d_target="#signupModal" btn_hidden="false" header="Opt in to the Preview for Engineering Reports!" >}} | ||
{{< /callout >}} | ||
|
||
## Overview | ||
|
||
Engineering Reports provide you with out-of-the-box, executive-level reports on product reliability, adherence to engineering standards, DORA metrics, and more. You can use these reports to uncover key insights, identify gaps, and drive improvements across your organization. The reports include aggregated views of key engineering metrics that are well suited for directors and executive leadership. | ||
|
||
domalessi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
{{< whatsnext desc="Explore the following reports:" >}} | ||
{{< nextlink href="/software_catalog/eng_reports/reliability_overview/" >}}Reliability Overview: Summary of your organization's reliability based on SLO performance and Incident trends.{{< /nextlink >}} | ||
{{< nextlink href="/software_catalog/eng_reports/scorecards_performance" >}}Scorecards Performance: Organization-wide view of Scorecard performance broken down by teams and rules.{{< /nextlink >}} | ||
{{< /whatsnext >}} | ||
|
||
## Further reading | ||
|
||
{{< partial name="whats-next/whats-next.html" >}} | ||
|
||
|
107 changes: 107 additions & 0 deletions
107
content/en/software_catalog/eng_reports/reliability_overview.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,107 @@ | ||
--- | ||
title: Reliability Overview | ||
further_reading: | ||
- link: "/service_management/service_level_objectives/" | ||
tag: "Documentation" | ||
text: "Service Level Objectives" | ||
- link: "service_management/incident_management/" | ||
tag: "Documentation" | ||
text: "Incident Management" | ||
- link: "dashboards/" | ||
tag: "Documentation" | ||
text: "Datadog Dashboards" | ||
--- | ||
|
||
{{< callout url="https://www.datadoghq.com/product-preview/engineering-reports/" d_target="#signupModal" btn_hidden="false" header="Opt in to the Preview for Engineering Reports!" >}} | ||
{{< /callout >}} | ||
|
||
## Overview | ||
|
||
The Reliability Overview report supports aggregated views of SLOs and Incidents to help executive leadership understand your organization's reliability at a glance. | ||
|
||
domalessi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
With this report, you can: | ||
- Customize your SLO or Incident groupings to be based on service, team, or other tags or properties that have been added to your SLOs or Incidents. | ||
- Use a summary score, based on the remaining error budget of the underlying SLOs, to understand SLO performance across different groups and identify areas of improvement. | ||
- Explore daily, weekly, and monthly historical reliability trends over the last 12 months to understand performance over time. | ||
|
||
Access the Reliability Overview report by clicking on the "Overview" tab in Internal Developer Portal (IDP) and selecting "Reliability Overview" in the left-hand menu. | ||
|
||
{{< img src="tracing/eng_reports/reliability-overview-landing2.png" alt="Default view of the Reliability Overview report, which shows SLO Performance data" style="width:100%;" >}} | ||
|
||
**Note:** If you have not opted into the Datadog IDP Preview, you can access the Reliability Overview report by clicking on the "Reports" tab at the top of the Software Catalog page. | ||
|
||
## Interact with your Reliability Overview report | ||
|
||
### Adjust your view | ||
|
||
{{< img src="tracing/eng_reports/reliability-overview-filtered2.png" alt="Reliability Overview page with an arrow highlighting the filtering options" style="width:100%;" >}} | ||
|
||
You can update your Reliability Overview report view in the following ways: | ||
|
||
- **Switch the aggregation between "Service" or "Team"**: View your organization's SLO and Incident performance by service/team groupings to identify top- and bottom-performing areas. | ||
|
||
**Note**: Service/team groupings are based on the **service** or **team** tag added to your SLOs, and the **services** or **teams** properties added to your Incidents. | ||
|
||
domalessi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
- **View daily, weekly, or monthly historical information**: Update the historical SLO and Incident trends to your desired granularity. | ||
- **Add filters to scope the data**: Filter by teams, services, and incident severity and state. | ||
|
||
### Schedule reports | ||
|
||
Set up scheduled reports for your stakeholders that are delivered as PDFs through email or Slack on a recurring basis. | ||
|
||
To schedule reports, click on **Schedule Report** in the top right corner (or **Manage Reports** if you've already set up reports). Refer to the [Scheduled Reports documentation][1] for more information. | ||
|
||
### Customize your report | ||
|
||
On the upper right corner of the report, click the kebab menu and select **Clone as a Dashboard** to create a dashboard with content from the Reliability Overview report. | ||
|
||
domalessi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
To customize the dashboard, you can: | ||
- Update the SLO Summary table to group by any tag you have added to your SLOs (for example, you can create a view grouped by "user journey") | ||
- Add widgets that are not included in the default view | ||
- Add filters to the existing widgets (for example, you can filter Incidents based on "Detection Method") | ||
|
||
## Use the SLO summary score | ||
|
||
{{< img src="tracing/eng_reports/slo-summary-score2.png" alt="The SLO Summary widget, including the SLO summary score" style="width:100%;" >}} | ||
|
||
The **SLO Summary** widget includes a "score". It is designed as a summary metric for executive leadership to understand the performance of a group of SLOs. The score is calculated based on the average remaining error budget of the underlying SLOs, which is then mapped to a score between 0 - 100: | ||
|
||
- The score is "passing" (green/yellow) when most SLOs are **not** breached and have remaining error budget. | ||
- The score is "failing" (red) when many SLOs are out of error budget or a few SLOs are far out of error budget. | ||
- SLOs in the "No Data" state are not considered in the score. | ||
|
||
### Score calculation details | ||
|
||
The score is calculated as follows: | ||
|
||
{{< jqmath-vanilla >}} | ||
|
||
$$ | ||
\text"Average Remaining Error Budget" | ||
= {∑_{i=0}^{n}\\text"[Remaining Error Budget]"_i} / n | ||
$$ | ||
|
||
$$ | ||
\text"Score" | ||
= {max(\text"[Average Remaining Error Budget]"\,-200) + 200} / 300 * 100 | ||
$$ | ||
|
||
|
||
- Average the remaining error budget of the SLOs (the minimum error budget is set to -200%, so any SLO with a lower error budget will be counted as -200% in the average). | ||
- Map the average error budget (between -200 and 100) to a score between 0 and 100. | ||
- Set the color and status of the score based on the following thresholds: | ||
- **Red:** 0 ≤ Score < 66.667 | ||
- **Yellow:** 66.667 ≤ Score < 80 | ||
- **Green:** 80 ≤ Score ≤ 100 | ||
|
||
**Note**: An average remaining error budget of 0% corresponds to a Score value of 66.667. | ||
|
||
domalessi marked this conversation as resolved.
Show resolved
Hide resolved
domalessi marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Further reading | ||
|
||
{{< partial name="whats-next/whats-next.html" >}} | ||
|
||
[1]: /dashboards/sharing/scheduled_reports/ | ||
|
||
|
||
|
64 changes: 64 additions & 0 deletions
64
content/en/software_catalog/eng_reports/scorecards_performance.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
--- | ||
title: Scorecards Performance | ||
further_reading: | ||
- link: "software_catalog/scorecards/" | ||
tag: "Documentation" | ||
text: "Datadog Scorecards" | ||
- link: "dashboards/" | ||
tag: "Documentation" | ||
text: "Datadog Dashboards" | ||
--- | ||
|
||
{{< callout url="https://www.datadoghq.com/product-preview/engineering-reports/" d_target="#signupModal" btn_hidden="false" header="Opt in to the Preview for Engineering Reports!" >}} | ||
{{< /callout >}} | ||
|
||
## Overview | ||
|
||
The Scorecards Performance report includes an organization-wide view of Scorecard performance by teams and rules, including historical trends. With this report, you can: | ||
- Identify highest and lowest performing teams by Scorecards and rules. | ||
- Filter information based on team, scorecard, rule, application, tier, and lifecycle. | ||
- Explore historical info for the last 12 months to identify trends over time. | ||
|
||
Access the Scorecards Performance report by clicking on the "Overview" tab in Internal Developer Portal (IDP) and selecting "Scorecards Performance" in the left-hand menu. | ||
|
||
{{< img src="tracing/eng_reports/scorecards-landing2.png" alt="Default view of the Scorecards Performance report, with the Performance by Scorecard sub-section visible" style="width:100%;" >}} | ||
|
||
**Note:** If you have not opted into the Datadog IDP Preview, you can access the Scorecards Performance report by clicking on the "Reports" tab at the top of the Software Catalog page. | ||
|
||
## Interact with your Scorecard Performance report | ||
|
||
### Adjust your view | ||
|
||
{{< img src="tracing/eng_reports/scorecards-filtered2.png" alt="Scorecard Performance report with an arrow highlighting the filtering options" style="width:100%;" >}} | ||
|
||
By default, the Scorecards Performance report breaks down data by team, which allows you to identify the highest- and lowest-performing teams across all Scorecards, specific Scorecards, or individual rules. | ||
|
||
You can update your Scorecard Performance report view in the following ways: | ||
|
||
- **Switch the aggregation between "Service" or "Team"**: View your organization's Scorecard performance by service/team groupings to identify top- and bottom-performing areas. | ||
- **Add filters to scope the data**: Filter by teams, services, scorecards, rules, systems, tiers, and lifecycles. | ||
|
||
**Note**: The data in the Scorecards Performance report reflects information for active Scorecard rules at any point in time. This means you will see historical information for rules that are now disabled. | ||
|
||
### Schedule reports | ||
|
||
Set up scheduled reports for your stakeholders that are delivered as PDFs through email or Slack on a recurring basis. | ||
|
||
To schedule reports, click on **Schedule Report** in the top right corner (or **Manage Reports** if you've already set up reports). Refer to the [Scheduled Reports documentation][1] for more information. | ||
|
||
### Customize your report | ||
|
||
On the upper right corner of the report, click the kebab menu and select **Clone as a Dashboard** to create a dashboard with content from the Scorecards Performance report. The dashboard reflects the "team" aggregated view. | ||
|
||
To customize the dashboard, you can: | ||
- Update the Scorecard leaderboard view to aggregate by dimensions other than team or service (for example, you can create a leaderboard view by "system" or "tier") | ||
- Add widgets that are not included in the default view | ||
- Add filters to the existing widgets | ||
|
||
## Further reading | ||
|
||
{{< partial name="whats-next/whats-next.html" >}} | ||
|
||
[1]: https://docs.datadoghq.com/dashboards/sharing/scheduled_reports/ | ||
|
||
|
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.