Skip to content

Add glossary entries for pipeline breakdown metrics #29534

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

Conversation

rodrigo-roca
Copy link
Contributor

@rodrigo-roca rodrigo-roca commented May 26, 2025

What does this PR do? What is the motivation?

We are adding 4 new metrics to the pipeline level for all CI providers in CI Visibility.

Merge instructions

Merge readiness:

  • Ready for merge

For Datadog employees:
Merge queue is enabled in this repo. Your branch name MUST follow the <name>/<description> convention and include the forward slash (/). Without this format, your pull request will not pass in CI, the GitLab pipeline will not run, and you won't get a branch preview. Getting a branch preview makes it easier for us to check any issues with your PR, such as broken links.

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:

/merge

Additional notes

@rodrigo-roca rodrigo-roca requested a review from a team as a code owner May 26, 2025 07:47
@rodrigo-roca rodrigo-roca requested review from a team and rodrimendoza May 26, 2025 08:45
@janine-c janine-c added the editorial review Waiting on a more in-depth review label May 26, 2025
@janine-c
Copy link
Contributor

janine-c commented May 26, 2025

Created DOCS-11021 to get our CI expert's eyes on this 🙂

Copy link
Contributor

@joepeeples joepeeples left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with a few small edit suggestions. Also, it's a bit atypical for the glossary to include granular details like tag names; most entries link to docs for more details. But there isn't currently a good home for this info in the docs, so makes sense to include in the glossary for now. Thanks!

Copy link
Contributor

github-actions bot commented May 29, 2025

✅ Documentation Team Review

The documentation team has approved this pull request. Thank you for your contribution!

Co-authored-by: Joe Peeples <joe.peeples@datadoghq.com>
---
Total amount of time spent by CI jobs on the critical path executing tasks.

The sum of all the breakdown metrics is equal to the pipeline duration (`@duration`).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not convinced about this. I had to read it a few times to realise it was referring to the rest of pipeline breakdown X metrics that we have in the glossary. I'd list them here to be clear on what we mean.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added the pipeline word before breakdown so it is a bit clearer but I think this will be more intutuive if we look it from the UI were all the entries will be consecutive

@rodrigo-roca
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jun 2, 2025

View all feedbacks in Devflow UI.

2025-06-02 12:51:28 UTC ℹ️ Start processing command /merge


2025-06-02 12:51:35 UTC ℹ️ MergeQueue: pull request added to the queue

The expected merge time in master is approximately 20m (p90).


2025-06-02 13:09:32 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 38d5eb1 into master Jun 2, 2025
24 of 26 checks passed
@dd-mergequeue dd-mergequeue bot deleted the rodrigo.roca/add-glossary-entry-pipeline-breakdown-tags branch June 2, 2025 13:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial review Waiting on a more in-depth review mergequeue-status: done
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants