Teddy.gesbert/doc dora #28316
Merged
Teddy.gesbert/doc dora #28316
Conversation
This file contains 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
github-actions
bot
added
Architecture
|
Jira ticket for reviewing this content: https://datadoghq.atlassian.net/browse/DOCS-10449 |
calvarjorge
reviewed
Mar 25, 2025
Co-authored-by: Jorge Calvar <[email protected]>
Change deployment.merge_time to Merge Time (i.e. metric to field) to avoid any confusion with previous Metrics type
calvarjorge
approved these changes
Mar 27, 2025
joepeeples
reviewed
Mar 27, 2025
| | Metric | Description | | ||
| |-------------------------------|----------------------------| | ||
| | `Deployment Frequency` | The number of deployments detected by Datadog based on your selected [deployment data source][10].| | ||
| | `Change Lead Time` | The age in `seconds` of all associated Git commits at the time of deployment.| |
There was a problem hiding this comment.
Not your change, but plain text seems appropriate for a general reference.
Suggested change
| | `Change Lead Time` | The age in `seconds` of all associated Git commits at the time of deployment.| | |
| | `Change Lead Time` | The age in seconds of all associated Git commits at the time of deployment.| |
| |-------------------------------|----------------------------| | ||
| | `Deployment Frequency` | The number of deployments detected by Datadog based on your selected [deployment data source][10].| | ||
| | `Change Lead Time` | The age in `seconds` of all associated Git commits at the time of deployment.| | ||
| | `Change Failure Rate` | Calculated with the formula `Count of Failures/Count of Deployments`. A big time rollup of at least 1 week is recommended to account for the time difference between deployments and when the failure starts.| |
There was a problem hiding this comment.
Suggested change
| | `Change Failure Rate` | Calculated with the formula `Count of Failures/Count of Deployments`. A big time rollup of at least 1 week is recommended to account for the time difference between deployments and when the failure starts.| | |
| | `Change Failure Rate` | Calculated with the formula `Count of Failures/Count of Deployments`. A long time rollup of at least 1 week is recommended to account for the time difference between deployments and when the failure starts.| |
| | `Deployment Frequency` | The number of deployments detected by Datadog based on your selected [deployment data source][10].| | ||
| | `Change Lead Time` | The age in `seconds` of all associated Git commits at the time of deployment.| | ||
| | `Change Failure Rate` | Calculated with the formula `Count of Failures/Count of Deployments`. A big time rollup of at least 1 week is recommended to account for the time difference between deployments and when the failure starts.| | ||
| | `Time to Restore` | The time in `seconds` between a failure's `started_at` and `finished_at` timestamps.| |
There was a problem hiding this comment.
Suggested change
| | `Time to Restore` | The time in `seconds` between a failure's `started_at` and `finished_at` timestamps.| | |
| | `Time to Restore` | The time in seconds between a failure's `started_at` and `finished_at` timestamps.| |
Comment on lines
68
to
69
| | `Time to Pr Ready` | Time from when the commit is created until the PR is ready for review. This metric is only available for commits that were made before the PR was marked as ready for review. | | ||
| | `Review Time` | Time from when the PR is marked ready for review until it receives the last approval. This metric is only available for commits that were made before the PR is approved. | |
There was a problem hiding this comment.
Suggested change
| | `Time to Pr Ready` | Time from when the commit is created until the PR is ready for review. This metric is only available for commits that were made before the PR was marked as ready for review. | | |
| | `Review Time` | Time from when the PR is marked ready for review until it receives the last approval. This metric is only available for commits that were made before the PR is approved. | | |
| | `Time to PR Ready` | Time from when the commit is created until the PR is ready for review. This metric is only available for commits made before the PR is marked as ready for review. | | |
| | `Review Time` | Time from when the PR is marked ready for review until it receives the last approval. This metric is only available for commits made before the PR is approved. | |
| | `dora.merge_time` | duration | Time from the last approval until the PR is merged. | | ||
| | `dora.time_to_deploy` | duration | Time from PR merge to start of deployment. If a commit does not have an associated PR, this metric is calculated as the time from commit creation to start of deployment. | | ||
| | `dora.deploy_time` | duration | Time from start of deployment to end of deployment. This metric is not available if there is no deployment duration information. | | ||
| These stages are only computed when the source of the repository metadata is GitHub, and there must be a pull request (PR) associated with a commit, if any. A commit is associated with a PR if the commit is first introduced to the target branch when merging that PR. If a commit has no associated PR, only `Time to Deploy` and `Deploy Time` fields are available. |
There was a problem hiding this comment.
Suggested change
| These stages are only computed when the source of the repository metadata is GitHub, and there must be a pull request (PR) associated with a commit, if any. A commit is associated with a PR if the commit is first introduced to the target branch when merging that PR. If a commit has no associated PR, only `Time to Deploy` and `Deploy Time` fields are available. | |
| These stages are only computed when the source of the repository metadata is GitHub, and for most stages there must be a pull request (PR) associated with a commit. A commit is associated with a PR if the commit is first introduced to the target branch when merging that PR. If a commit has no associated PR, only `Time to Deploy` and `Deploy Time` fields are available. |
Comment on lines
24
to
25
| [**Failures events**][9] | ||
| : Indicate that a new failure has occurred for a service in a specific environment. Failures events are used to compute change failure rate and time to restore. |
There was a problem hiding this comment.
Suggested change
| [**Failures events**][9] | |
| : Indicate that a new failure has occurred for a service in a specific environment. Failures events are used to compute change failure rate and time to restore. | |
| [**Failure events**][9] | |
| : Indicate that a new failure has occurred for a service in a specific environment. Failure events are used to compute change failure rate and time to restore. |
| - `service`: The service that was deployed. If the provided service is registered in the [Software Catalog][23] with metadata set up (see [Adding Metadata][24]), the `team` of the service is automatically retrieved and associated with all metrics. | ||
| ### Requirements | ||
|
|
||
| - datadog-ci CLI / API is enabled as a deployment events data source in [DORA settings][28]. |
There was a problem hiding this comment.
Suggested change
| - datadog-ci CLI / API is enabled as a deployment events data source in [DORA settings][28]. | |
| - **datadog-ci CLI / API** is enabled as a **Deployments** event data source in [DORA settings][28]. |
Comment on lines
72
to
77
| - `repository_url`: The source code repository of the service. ***Required for calculating change lead time*** | ||
| - `commit_sha`: The SHA of the HEAD commit associated with the deployment. ***Required for calculating change lead time*** | ||
| - `team` to associate a deployment with a different `team` than the one found automatically for the service. | ||
| - `env` to filter your DORA metrics by environment on the [**DORA Metrics** page][25]. | ||
| - `id` for identifying a deployment. This attribute is user-generated; when not provided, the endpoint returns a Datadog-generated UUID. | ||
| - `version` |
There was a problem hiding this comment.
Suggested change
| - `repository_url`: The source code repository of the service. ***Required for calculating change lead time*** | |
| - `commit_sha`: The SHA of the HEAD commit associated with the deployment. ***Required for calculating change lead time*** | |
| - `team` to associate a deployment with a different `team` than the one found automatically for the service. | |
| - `env` to filter your DORA metrics by environment on the [**DORA Metrics** page][25]. | |
| - `id` for identifying a deployment. This attribute is user-generated; when not provided, the endpoint returns a Datadog-generated UUID. | |
| - `version` | |
| - `repository_url`: The source code repository of the service. Required for calculating change lead time. | |
| - `commit_sha`: The SHA of the HEAD commit associated with the deployment. Required for calculating change lead time. | |
| - `team`: Associate a deployment with a different `team` than the one found automatically for the service. | |
| - `env`: Filter your DORA metrics by environment on the [DORA Metrics][25] page. | |
| - `id`: Identify a deployment. This attribute is user-generated; when not provided, the endpoint returns a Datadog-generated UUID. | |
| - `version`: The deployment version. |
| @@ -1,6 +1,6 @@ | |||
| --- | |||
| title: How to Set Up Incident Data for DORA Metrics | |||
| description: Learn how to send incident events for DORA Metrics. | |||
| title: How to Set Up Failure Data for DORA Metrics | |||
There was a problem hiding this comment.
Suggested change
| title: How to Set Up Failure Data for DORA Metrics | |
| title: Set Up Failure Data for DORA Metrics |
Applied suggestions from Joe Peeples
joepeeples
approved these changes
Mar 27, 2025
There was a problem hiding this comment.
Just a couple small comments but LGTM! Thanks for preparing this content @Tecoddy !
|
|
||
| | Field | Type | Description | | ||
| |------------|--------|----------------------------| | ||
| | `Duration` | number (s) | Duration of the deployment. | |
There was a problem hiding this comment.
Also, if you're planning to keep the Type column in these tables, just "number" is sufficient for all the rows instead of "number (s)" -- It'll be clear that values need to be numbers, regardless of how many there are.
Suggested change
| | `Duration` | number (s) | Duration of the deployment. | | |
| | `Duration` | number | Duration of the deployment. | |
LisianeTu
approved these changes
Apr 8, 2025
henrywalsh
approved these changes
Apr 8, 2025
Co-authored-by: Joe Peeples <[email protected]>
|
/merge |
|
View all feedbacks in Devflow UI.
The expected merge time in
|
dd-devflow
bot
added
mergequeue-status: queued
mergequeue-status: in_progress
and removed
mergequeue-status: queued
labels
dd-devflow
bot
added
mergequeue-status: done
and removed
mergequeue-status: in_progress
labels
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What does this PR do? What is the motivation?
To avoid confusion with Incident Management, the documentation should no longer reference “Incident Events” when describing failures. Instead, all references should use “Failures”, ensuring consistency with terminology used in the product.
Customers often miss the requirements for setting up Dora metrics. Added a dedicated Requirements section to make it more clear for customers to see what’s needed.
Version tag does not appear as an optional tag in setup documentation.
As we will use the median instead of average for Time to Restore, using Mean Time to Restore is not relevant anymore.
As we are migrating to a new event-based storage system, we need to do a few updates to adapt to the new structure.
Details :
Change dora.xxxxx to new DORA Metrics
Data collected : Change structure and information provided.
Merge instructions
Merge readiness:
Merge queue is enabled in this repo. Your branch name MUST follow the
<slack_username>/<branch_name>convention, or your pull request will not pass in CI. If your branch doesn't follow this format, rename it or create a new branch and PR.To have your PR automatically merged after it receives the required reviews, add the following PR comment:
Additional notes