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

Gateway usage gauge #33370

Merged
merged 13 commits into from
Feb 3, 2025
Merged

Gateway usage gauge #33370

merged 13 commits into from
Feb 3, 2025

Conversation

ogaca-dd
Copy link
Contributor

@ogaca-dd ogaca-dd commented Jan 24, 2025

What does this PR do?

This PR adds a nil argument for the changes done by DataDog/opentelemetry-mapping-go#479.
For now, the metric datadog.otel.gateway is not sent for OTLP ingest for for OTEL agent. This is eventually done in a later PR.

See open-telemetry/opentelemetry-collector-contrib#37499 for additional context.

Note: OTLPReceiver.ReceiveResourceSpans takes attributes.HostFromAttributesHandler for open-telemetry/opentelemetry-collector-contrib#37499.

Motivation

Describe how you validated your changes

Unit tests and e2e tests.

Possible Drawbacks / Trade-offs

Additional Notes

@ogaca-dd ogaca-dd requested review from a team as code owners January 24, 2025 17:14
@ogaca-dd ogaca-dd requested a review from ankitpatel96 January 24, 2025 17:14
@ogaca-dd ogaca-dd marked this pull request as draft January 24, 2025 17:14
@ogaca-dd ogaca-dd added the qa/done QA done before merge and regressions are covered by tests label Jan 27, 2025
@ogaca-dd ogaca-dd changed the title Olivierg/gateway usage gauge Gateway usage gauge Jan 27, 2025
@ogaca-dd ogaca-dd marked this pull request as ready for review January 27, 2025 13:12
@github-actions github-actions bot added the long review PR is complex, plan time to review it label Jan 29, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Jan 29, 2025

Uncompressed package size comparison

Comparison with ancestor 2d763d6d5b3102e3abc79144adc8907d608b0eff

Diff per package
package diff status size ancestor threshold
datadog-agent-aarch64-rpm 0.07MB ⚠️ 874.76MB 874.69MB 0.50MB
datadog-agent-arm64-deb 0.07MB ⚠️ 865.04MB 864.97MB 0.50MB
datadog-agent-x86_64-rpm 0.06MB ⚠️ 886.98MB 886.92MB 0.50MB
datadog-agent-x86_64-suse 0.06MB ⚠️ 886.98MB 886.92MB 0.50MB
datadog-agent-amd64-deb 0.06MB ⚠️ 877.24MB 877.18MB 0.50MB
datadog-heroku-agent-amd64-deb 0.03MB ⚠️ 456.48MB 456.45MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.02MB ⚠️ 89.98MB 89.96MB 0.50MB
datadog-iot-agent-arm64-deb 0.02MB ⚠️ 89.91MB 89.89MB 0.50MB
datadog-iot-agent-amd64-deb 0.02MB ⚠️ 93.86MB 93.84MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.02MB ⚠️ 93.93MB 93.91MB 0.50MB
datadog-iot-agent-x86_64-suse 0.02MB ⚠️ 93.92MB 93.91MB 0.50MB
datadog-dogstatsd-amd64-deb 0.01MB ⚠️ 59.03MB 59.02MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.01MB ⚠️ 59.11MB 59.10MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.01MB ⚠️ 59.11MB 59.10MB 0.50MB
datadog-dogstatsd-arm64-deb 0.01MB ⚠️ 56.52MB 56.51MB 0.50MB

Decision

⚠️ Warning

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Jan 29, 2025

Test changes on VM

Use this command from test-infra-definitions to manually test this PR changes on a VM:

inv aws.create-vm --pipeline-id=54727709 --os-family=ubuntu

Note: This applies to commit 8f1ba93

Copy link

cit-pr-commenter bot commented Jan 29, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: f98cdc36-abf1-43c3-bc95-caef6d86a4c1

Baseline: 2d763d6
Comparison: 8f1ba93
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
uds_dogstatsd_to_api_cpu % cpu utilization +1.67 [+0.78, +2.57] 1 Logs
quality_gate_idle memory utilization +0.71 [+0.65, +0.77] 1 Logs bounds checks dashboard
file_tree memory utilization +0.07 [+0.00, +0.13] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.06 [-0.72, +0.83] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.05 [-0.42, +0.52] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.03 [-0.66, +0.73] 1 Logs
quality_gate_idle_all_features memory utilization +0.03 [-0.04, +0.09] 1 Logs bounds checks dashboard
file_to_blackhole_0ms_latency_http1 egress throughput +0.02 [-0.82, +0.87] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.01 [-0.82, +0.84] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.00 [-0.02, +0.01] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.02 [-0.30, +0.26] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.02 [-0.66, +0.61] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput -0.03 [-0.93, +0.87] 1 Logs
file_to_blackhole_500ms_latency egress throughput -0.04 [-0.83, +0.74] 1 Logs
quality_gate_logs % cpu utilization -0.95 [-3.97, +2.07] 1 Logs
tcp_syslog_to_blackhole ingress throughput -2.52 [-2.60, -2.45] 1 Logs

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
file_to_blackhole_0ms_latency lost_bytes 10/10
file_to_blackhole_0ms_latency memory_usage 10/10
file_to_blackhole_0ms_latency_http1 lost_bytes 10/10
file_to_blackhole_0ms_latency_http1 memory_usage 10/10
file_to_blackhole_0ms_latency_http2 lost_bytes 10/10
file_to_blackhole_0ms_latency_http2 memory_usage 10/10
file_to_blackhole_1000ms_latency memory_usage 10/10
file_to_blackhole_1000ms_latency_linear_load memory_usage 10/10
file_to_blackhole_100ms_latency lost_bytes 10/10
file_to_blackhole_100ms_latency memory_usage 10/10
file_to_blackhole_300ms_latency lost_bytes 10/10
file_to_blackhole_300ms_latency memory_usage 10/10
file_to_blackhole_500ms_latency lost_bytes 10/10
file_to_blackhole_500ms_latency memory_usage 10/10
quality_gate_idle intake_connections 10/10 bounds checks dashboard
quality_gate_idle memory_usage 10/10 bounds checks dashboard
quality_gate_idle_all_features intake_connections 10/10 bounds checks dashboard
quality_gate_idle_all_features memory_usage 10/10 bounds checks dashboard
quality_gate_logs intake_connections 10/10
quality_gate_logs lost_bytes 10/10
quality_gate_logs memory_usage 10/10

Explanation

Confidence level: 90.00%
Effect size tolerance: |Δ mean %| ≥ 5.00%

Performance changes are noted in the perf column of each table:

  • ✅ = significantly better comparison variant performance
  • ❌ = significantly worse comparison variant performance
  • ➖ = no significant change in performance

A regression test is an A/B test of target performance in a repeatable rig, where "performance" is measured as "comparison variant minus baseline variant" for an optimization goal (e.g., ingress throughput). Due to intrinsic variability in measuring that goal, we can only estimate its mean value for each experiment; we report uncertainty in that value as a 90.00% confidence interval denoted "Δ mean % CI".

For each experiment, we decide whether a change in performance is a "regression" -- a change worth investigating further -- if all of the following criteria are true:

  1. Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.

  2. Its 90.00% confidence interval "Δ mean % CI" does not contain zero, indicating that if our statistical model is accurate, there is at least a 90.00% chance there is a difference in performance between baseline and comparison variants.

  3. Its configuration does not mark it "erratic".

CI Pass/Fail Decision

Passed. All Quality Gates passed.

  • quality_gate_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
  • quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.

@@ -77,7 +77,7 @@ func (c component) SetOTelAttributeTranslator(attrstrans *attributes.Translator)
}

func (c component) ReceiveOTLPSpans(ctx context.Context, rspans ptrace.ResourceSpans, httpHeader http.Header) source.Source {
Copy link
Member

Choose a reason for hiding this comment

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

nit: you can add hostFromAttributesHandler to this func as well (ignore if you plan to do it in a follow-up PR)

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 tried to minimise the changes as I had many issues with repository cross dependencies. I'll do it in a follow-up PR.

go.mod Outdated Show resolved Hide resolved
@songy23 songy23 removed the request for review from ankitpatel96 January 29, 2025 19:30
@ogaca-dd ogaca-dd requested review from a team as code owners January 31, 2025 10:46
@ogaca-dd
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Jan 31, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-01-31 15:19:09 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 27m.


2025-01-31 17:27:40 UTCMergeQueue: The build pipeline contains failing jobs for this merge request

Build pipeline has failing jobs for 13c584c:

⚠️ Do NOT retry failed jobs directly (why?).

What to do next?

  • Investigate the failures and when ready, re-add your pull request to the queue!
  • If your PR checks are green, try to rebase/merge. It might be because the CI run is a bit old.
  • Any question, go check the FAQ.
Details

Since those jobs are not marked as being allowed to fail, the pipeline will most likely fail.
Therefore, and to allow other builds to be processed, this merge request has been rejected and the pipeline got canceled.

@ogaca-dd ogaca-dd requested a review from a team as a code owner February 3, 2025 09:57
@ogaca-dd ogaca-dd requested a review from a team as a code owner February 3, 2025 15:29
@agent-platform-auto-pr
Copy link
Contributor

Gitlab CI Configuration Changes

Removed Jobs

  • datadog_otel_components_ocb_build

Changes Summary

Removed Modified Added Renamed
1 0 0 0

ℹ️ Diff available in the job log.

when: never
- when: always
timeout: 15 minutes
# datadog_otel_components_ocb_build:
Copy link
Member

Choose a reason for hiding this comment

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

Please create a card to restore it so that we don't forget

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Tracked by OTAGENT-270

@ogaca-dd
Copy link
Contributor Author

ogaca-dd commented Feb 3, 2025

/merge

@dd-devflow
Copy link

dd-devflow bot commented Feb 3, 2025

Devflow running: /merge

View all feedbacks in Devflow UI.


2025-02-03 16:25:56 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 27m.


2025-02-03 17:08:21 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 31c3d5c into main Feb 3, 2025
423 of 427 checks passed
@dd-mergequeue dd-mergequeue bot deleted the olivierg/gateway-usage-gauge branch February 3, 2025 17:08
songy23 added a commit to open-telemetry/opentelemetry-collector-contrib that referenced this pull request Feb 7, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

This PR adds a new gauge metric `datadog.otel.gateway`. This metric is
set at `1` when the collector is used as a gateway otherwise, the value
is `0`.
If `datadog.host.name` was sent with two different values, then the
collector is used as a gateway.

Note: [The PR on
opentelemetry-mapping-go](DataDog/opentelemetry-mapping-go#479)
should be merged before this PR and `go.mod` must use a commit on main
instead of `0.24.1-0.20250124131402-bcd6fd1617a6`

Associated PRs:
- DataDog/opentelemetry-mapping-go#479
- DataDog/datadog-agent#33370
<!-- Issue number (e.g. #1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes

<!--Describe what testing was performed and which tests were added.-->
#### Testing
The following commands generates the metric `datadog.otel.gateway` at
`1`
```
telemetrygen metrics --otlp-insecure   --otlp-attributes "datadog.host.name"=\"host1\"
telemetrygen metrics --otlp-insecure   --otlp-attributes "datadog.host.name"=\"host2\"
```

Same tests were performed for `traces` and for `logs` when
`isLogsAgentExporterEnabled` is false.


<!--Describe the documentation added.-->
#### Documentation

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Yang Song <[email protected]>
chengchuanpeng pushed a commit to chengchuanpeng/opentelemetry-collector-contrib that referenced this pull request Feb 8, 2025
<!--Ex. Fixing a bug - Describe the bug and how this fixes the issue.
Ex. Adding a feature - Explain what this achieves.-->
#### Description

This PR adds a new gauge metric `datadog.otel.gateway`. This metric is
set at `1` when the collector is used as a gateway otherwise, the value
is `0`.
If `datadog.host.name` was sent with two different values, then the
collector is used as a gateway.

Note: [The PR on
opentelemetry-mapping-go](DataDog/opentelemetry-mapping-go#479)
should be merged before this PR and `go.mod` must use a commit on main
instead of `0.24.1-0.20250124131402-bcd6fd1617a6`

Associated PRs:
- DataDog/opentelemetry-mapping-go#479
- DataDog/datadog-agent#33370
<!-- Issue number (e.g. open-telemetry#1234) or full URL to issue, if applicable. -->
#### Link to tracking issue
Fixes

<!--Describe what testing was performed and which tests were added.-->
#### Testing
The following commands generates the metric `datadog.otel.gateway` at
`1`
```
telemetrygen metrics --otlp-insecure   --otlp-attributes "datadog.host.name"=\"host1\"
telemetrygen metrics --otlp-insecure   --otlp-attributes "datadog.host.name"=\"host2\"
```

Same tests were performed for `traces` and for `logs` when
`isLogsAgentExporterEnabled` is false.


<!--Describe the documentation added.-->
#### Documentation

<!--Please delete paragraphs that you did not use before submitting.-->

---------

Co-authored-by: Yang Song <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog long review PR is complex, plan time to review it qa/done QA done before merge and regressions are covered by tests team/opentelemetry OpenTelemetry team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants