Skip to content

Reformat documentation#331

Merged
xlamorlette-datadog merged 13 commits into
mainfrom
xlamorlette/update-architecture-documentation
Jul 2, 2026
Merged

Reformat documentation#331
xlamorlette-datadog merged 13 commits into
mainfrom
xlamorlette/update-architecture-documentation

Conversation

@xlamorlette-datadog

@xlamorlette-datadog xlamorlette-datadog commented Jul 1, 2026

Copy link
Copy Markdown
Collaborator

Description

This is only reformatting of the various documentation files.

By the way, also cleaned everywhere in the code comments and error messages very old deprecated typographic rules (two spaces after full stop).

Motivation

This wide reformating will make upcoming modifications about documentation easier to review.

Additional Notes

Jira ticket: IDMPL-549 C++ Tracer: update and improve architecture documentation

@pr-commenter

pr-commenter Bot commented Jul 1, 2026

Copy link
Copy Markdown

Benchmarks

Benchmark execution time: 2026-07-02 15:03:41

Comparing candidate commit 4b6e13d in PR branch xlamorlette/update-architecture-documentation with baseline commit d7ea3a8 in branch main.

Found 0 performance improvements and 0 performance regressions! Performance is the same for 8 metrics, 0 unstable metrics.

Explanation

This is an A/B test comparing a candidate commit's performance against that of a baseline commit. Performance changes are noted in the tables below as:

  • 🟩 = significantly better candidate vs. baseline
  • 🟥 = significantly worse candidate vs. baseline

We compute a confidence interval (CI) over the relative difference of means between metrics from the candidate and baseline commits, considering the baseline as the reference.

If the CI is entirely outside the configured SIGNIFICANT_IMPACT_THRESHOLD (or the deprecated UNCONFIDENCE_THRESHOLD), the change is considered significant.

Feel free to reach out to #apm-benchmarking-platform on Slack if you have any questions.

More details about the CI and significant changes

You can imagine this CI as a range of values that is likely to contain the true difference of means between the candidate and baseline commits.

CIs of the difference of means are often centered around 0%, because often changes are not that big:

---------------------------------(------|---^--------)-------------------------------->
                              -0.6%    0%  0.3%     +1.2%
                                 |          |        |
         lower bound of the CI --'          |        |
sample mean (center of the CI) -------------'        |
         upper bound of the CI ----------------------'

As described above, a change is considered significant if the CI is entirely outside the configured SIGNIFICANT_IMPACT_THRESHOLD (or the deprecated UNCONFIDENCE_THRESHOLD).

For instance, for an execution time metric, this confidence interval indicates a significantly worse performance:

----------------------------------------|---------|---(---------^---------)---------->
                                       0%        1%  1.3%      2.2%      3.1%
                                                  |   |         |         |
       significant impact threshold --------------'   |         |         |
                      lower bound of CI --------------'         |         |
       sample mean (center of the CI) --------------------------'         |
                      upper bound of CI ----------------------------------'

@datadog-datadog-us1-prod

datadog-datadog-us1-prod Bot commented Jul 1, 2026

Copy link
Copy Markdown

🎯 Code Coverage (details)
Patch Coverage: 100.00%
Overall Coverage: 91.66% (-0.02%)

This comment will be updated automatically if new data arrives.
🔗 Commit SHA: 4b6e13d | Docs | Datadog PR Page | Give us feedback!

@dubloom dubloom left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I didn't give a super in-depth look but I looked at all the files and it looked to be just formatting so LGTM

@xlamorlette-datadog xlamorlette-datadog merged commit 9aa0079 into main Jul 2, 2026
38 checks passed
@xlamorlette-datadog xlamorlette-datadog deleted the xlamorlette/update-architecture-documentation branch July 2, 2026 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants