Skip to content
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

Updating the documentation of v04 proto file #21036

Merged
merged 2 commits into from Nov 22, 2023

Conversation

fpddog
Copy link
Contributor

@fpddog fpddog commented Nov 22, 2023

What does this PR do?

The comments for v04 reference the location of the request payload proto file, which was recently(ish) moved from pkg/trace/pb/span.proto to pkg/proto/datadog/trace/span.proto (see: https://github.com/DataDog/datadog-agent/pull/10650/files#diff-235ec354aa017d69a8115cfc766bfb04271bff2a707e5c6a1c99095e43423207).

This pr corrects the documents so that they point to new location of the proto file.

Motivation

Easy tech debt win.

Additional Notes

N/A

Possible Drawbacks / Trade-offs

None.

Describe how to test/QA your changes

Doesn't apply.

Reviewer's Checklist

  • If known, an appropriate milestone has been selected; otherwise the Triage milestone is set.
  • Use the major_change label if your change either has a major impact on the code base, is impacting multiple teams or is changing important well-established internals of the Agent. This label will be use during QA to make sure each team pay extra attention to the changed behavior. For any customer facing change use a releasenote.
  • A release note has been added or the changelog/no-changelog label has been applied.
  • Changed code has automated tests for its functionality.
  • Adequate QA/testing plan information is provided if the qa/skip-qa label is not applied.
  • At least one team/.. label has been applied, indicating the team(s) that should QA this change.
  • If applicable, docs team has been notified or an issue has been opened on the documentation repo.
  • If applicable, the need-change/operator and need-change/helm labels have been applied.
  • If applicable, the k8s/<min-version> label, indicating the lowest Kubernetes version compatible with this feature.
  • If applicable, the config template has been updated.

The comments for v04 reference the location of the request payload proto file, which was recently(ish) moved from `pkg/trace/pb/span.proto` to `pkg/proto/datadog/trace/span.proto` (see: https://github.com/DataDog/datadog-agent/pull/10650/files#diff-235ec354aa017d69a8115cfc766bfb04271bff2a707e5c6a1c99095e43423207).

This pr corrects the documents so that they point to new location of the proto file.
@fpddog fpddog requested a review from a team as a code owner November 22, 2023 14:26
@bits-bot
Copy link
Collaborator

bits-bot commented Nov 22, 2023

CLA assistant check
All committers have signed the CLA.

Copy link
Contributor

@ajgajg1134 ajgajg1134 left a comment

Choose a reason for hiding this comment

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

thanks!

@fpddog fpddog added this to the 7.51.0 milestone Nov 22, 2023
@pr-commenter
Copy link

pr-commenter bot commented Nov 22, 2023

Bloop Bleep... Dogbot Here

Regression Detector Results

Run ID: cc46970a-6a98-45c7-8753-01862b223f86
Baseline: dbcc248
Comparison: 631af56
Total datadog-agent CPUs: 7

Explanation

A regression test is an integrated performance test for datadog-agent in a repeatable rig, with varying configuration for datadog-agent. What follows is a statistical summary of a brief datadog-agent run for each configuration across SHAs given above. The goal of these tests are to determine quickly if datadog-agent performance is changed and to what degree by a pull request.

Because a target's optimization goal performance in each experiment will vary somewhat each time it is run, we can only estimate mean differences in optimization goal relative to the baseline target. We express these differences as a percentage change relative to the baseline target, denoted "Δ mean %". These estimates are made to a precision that balances accuracy and cost control. We represent this precision as a 90.00% confidence interval denoted "Δ mean % CI": there is a 90.00% chance that the true value of "Δ mean %" is in that interval.

We decide whether a change in performance is a "regression" -- a change worth investigating further -- if both of the following two criteria are true:

  1. The estimated |Δ mean %| ≥ 5.00%. This criterion intends to answer the question "Does the estimated change in mean optimization goal performance have a meaningful impact on your customers?". We assume that when |Δ mean %| < 5.00%, the impact on your customers is not meaningful. We also assume that a performance change in optimization goal is worth investigating whether it is an increase or decrease, so long as the magnitude of the change is sufficiently large.

  2. Zero is not in the 90.00% confidence interval "Δ mean % CI" about "Δ mean %". This statement is equivalent to saying that there is at least a 90.00% chance that the mean difference in optimization goal is not zero. This criterion intends to answer the question, "Is there a statistically significant difference in mean optimization goal performance?". It also means there is no more than a 10.00% chance this criterion reports a statistically significant difference when the true difference in mean optimization goal is zero -- a "false positive". We assume you are willing to accept a 10.00% chance of inaccurately detecting a change in performance when no true difference exists.

The table below, if present, lists those experiments that have experienced a statistically significant change in mean optimization goal performance between baseline and comparison SHAs with 90.00% confidence OR have been detected as newly erratic. Negative values of "Δ mean %" mean that baseline is faster, whereas positive values of "Δ mean %" mean that comparison is faster. Results that do not exhibit more than a ±5.00% change in their mean optimization goal are discarded. An experiment is erratic if its coefficient of variation is greater than 0.1. The abbreviated table will be omitted if no interesting change is observed.

No interesting changes in experiment optimization goals with confidence ≥ 90.00% and |Δ mean %| ≥ 5.00%.

Fine details of change detection per experiment.
experiment goal Δ mean % Δ mean % CI confidence
file_tree egress throughput +0.37 [-1.51, +2.24] 25.13%
dogstatsd_string_interner_8MiB_100k ingress throughput +0.03 [-0.03, +0.10] 60.42%
trace_agent_msgpack ingress throughput +0.03 [-0.10, +0.16] 32.25%
dogstatsd_string_interner_64MiB_1k ingress throughput +0.00 [-0.13, +0.13] 1.86%
file_to_blackhole egress throughput +0.00 [-1.02, +1.02] 0.21%
dogstatsd_string_interner_64MiB_100 ingress throughput +0.00 [-0.13, +0.14] 0.90%
dogstatsd_string_interner_128MiB_1k ingress throughput -0.00 [-0.14, +0.14] 0.16%
dogstatsd_string_interner_128MiB_100 ingress throughput -0.00 [-0.14, +0.14] 0.24%
dogstatsd_string_interner_8MiB_100 ingress throughput -0.00 [-0.13, +0.13] 1.70%
dogstatsd_string_interner_8MiB_1k ingress throughput -0.00 [-0.10, +0.10] 5.68%
dogstatsd_string_interner_8MiB_10k ingress throughput -0.01 [-0.07, +0.05] 28.29%
tcp_dd_logs_filter_exclude ingress throughput -0.01 [-0.16, +0.13] 12.32%
dogstatsd_string_interner_8MiB_50k ingress throughput -0.02 [-0.06, +0.01] 74.34%
trace_agent_json ingress throughput -0.03 [-0.16, +0.09] 34.25%
uds_dogstatsd_to_api ingress throughput -0.04 [-0.21, +0.14] 26.32%
idle egress throughput -0.04 [-2.49, +2.42] 2.01%
otel_to_otel_logs ingress throughput -0.05 [-1.64, +1.54] 4.05%
tcp_syslog_to_blackhole ingress throughput -0.53 [-0.67, -0.39] 100.00%

@fpddog fpddog merged commit 33631bd into main Nov 22, 2023
145 checks passed
@fpddog fpddog deleted the fpddog/v04_comments_proto_file_location branch November 22, 2023 17:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants