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

[AGNTLOG-61] Log Compression validator #33893

Merged
merged 9 commits into from
Feb 12, 2025

Conversation

DDuongNguyen
Copy link
Contributor

@DDuongNguyen DDuongNguyen commented Feb 10, 2025

What does this PR do?

This PR adds a new validator and unit test for existing log compression config for the log agent.

Motivation

Previously if the user used an invalid config for the compression, the agent would skip compression instead of falling back to the default compression

Describe how you validated your changes

Used the following configs for the compression_kind:

  1. gzip
  2. zstd
  3. mowmow
log_level: debug
logs_config:
    use_compression: true
    compression_kind: mowmow

There should be debug and warn logs for the type of compression the log agent is using. eg:

Logs agent is using: %s compression

and

Invalid compression kind: %s, falling back to default compression

Possible Drawbacks / Trade-offs

Additional Notes

@DDuongNguyen DDuongNguyen changed the title AGNTLOG-61 [AGNTLOG-61] Log Compression validator Feb 10, 2025
@github-actions github-actions bot added short review PR is simple enough to be reviewed quickly team/agent-log-pipelines labels Feb 10, 2025
@DDuongNguyen DDuongNguyen added the qa/done QA done before merge and regressions are covered by tests label Feb 10, 2025
@DDuongNguyen DDuongNguyen marked this pull request as ready for review February 10, 2025 21:03
@DDuongNguyen DDuongNguyen requested review from a team as code owners February 10, 2025 21:03
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 10, 2025

Uncompressed package size comparison

Comparison with ancestor 8b7083d5e900d289a5bab724ab66b3a45677754b

Diff per package
package diff status size ancestor threshold
datadog-agent-amd64-deb 0.00MB 869.12MB 869.11MB 0.50MB
datadog-agent-x86_64-rpm 0.00MB 878.88MB 878.88MB 0.50MB
datadog-agent-x86_64-suse 0.00MB 878.88MB 878.88MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 56.53MB 56.53MB 0.50MB
datadog-iot-agent-arm64-deb 0.00MB 82.63MB 82.63MB 0.50MB
datadog-iot-agent-aarch64-rpm 0.00MB 82.70MB 82.70MB 0.50MB
datadog-iot-agent-x86_64-rpm 0.00MB 86.42MB 86.42MB 0.50MB
datadog-iot-agent-x86_64-suse 0.00MB 86.42MB 86.42MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 59.12MB 59.12MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 59.12MB 59.12MB 0.50MB
datadog-agent-arm64-deb 0.00MB 857.53MB 857.53MB 0.50MB
datadog-agent-aarch64-rpm 0.00MB 867.28MB 867.28MB 0.50MB
datadog-dogstatsd-amd64-deb 0.00MB 59.04MB 59.04MB 0.50MB
datadog-heroku-agent-amd64-deb 0.00MB 441.07MB 441.07MB 0.50MB
datadog-iot-agent-amd64-deb 0.00MB 86.35MB 86.35MB 0.50MB

Decision

✅ Passed

@DDuongNguyen DDuongNguyen requested a review from a team as a code owner February 10, 2025 21:09
@github-actions github-actions bot added medium review PR review might take time and removed short review PR is simple enough to be reviewed quickly labels Feb 10, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 10, 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=55466957 --os-family=ubuntu

Note: This applies to commit 3b5ddb0

@janine-c janine-c self-assigned this Feb 10, 2025
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented Feb 10, 2025

Static quality checks ✅

Please find below the results from static quality gates

Info

Result Quality gate On disk size On disk size limit On wire size On wire size limit
static_quality_gate_agent_deb_amd64 840.79MiB 858.45MiB 203.57MiB 214.3MiB
static_quality_gate_docker_agent_amd64 925.01MiB 942.69MiB 309.89MiB 321.56MiB
static_quality_gate_docker_agent_arm64 937.29MiB 952.69MiB 293.77MiB 351.22MiB
static_quality_gate_docker_agent_jmx_amd64 1.1GiB 1.11GiB 384.97MiB 395.8MiB
static_quality_gate_docker_agent_jmx_arm64 1.1GiB 1.11GiB 364.86MiB 375.5MiB
static_quality_gate_docker_dogstatsd_amd64 47.86MiB 57.88MiB 18.29MiB 28.29MiB
static_quality_gate_docker_dogstatsd_arm64 46.26MiB 56.27MiB 17.05MiB 27.06MiB
static_quality_gate_docker_cluster_agent_amd64 267.69MiB 277.7MiB 107.27MiB 117.28MiB
static_quality_gate_docker_cluster_agent_arm64 283.73MiB 293.73MiB 102.1MiB 112.12MiB

Co-authored-by: Janine Chan <[email protected]>
@dustmop dustmop self-requested a review February 10, 2025 21:20
Copy link
Contributor

@soberpeach soberpeach left a comment

Choose a reason for hiding this comment

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

Just a few nits

comp/logs/agent/config/config_keys.go Outdated Show resolved Hide resolved
comp/logs/agent/config/endpoints_test.go Show resolved Hide resolved
Copy link
Contributor

@soberpeach soberpeach left a comment

Choose a reason for hiding this comment

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

lgtm

Copy link

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 5c02db63-3ef5-42a5-9162-2c6f9ca2239f

Baseline: 8b7083d
Comparison: 3b5ddb0
Diff

Optimization Goals: ✅ No significant changes detected

Fine details of change detection per experiment

perf experiment goal Δ mean % Δ mean % CI trials links
quality_gate_logs % cpu utilization +3.80 [+0.70, +6.91] 1 Logs
quality_gate_idle memory utilization +0.42 [+0.38, +0.45] 1 Logs bounds checks dashboard
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.39 [-0.08, +0.86] 1 Logs
uds_dogstatsd_to_api_cpu % cpu utilization +0.31 [-0.59, +1.20] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.21 [-0.57, +0.99] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.10 [-0.81, +1.01] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.07 [-0.71, +0.86] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.02 [-0.66, +0.70] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.01 [-0.87, +0.89] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput +0.00 [-0.01, +0.02] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.00 [-0.88, +0.88] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.00 [-0.30, +0.29] 1 Logs
file_to_blackhole_300ms_latency egress throughput -0.02 [-0.66, +0.62] 1 Logs
quality_gate_idle_all_features memory utilization -0.08 [-0.13, -0.03] 1 Logs bounds checks dashboard
tcp_syslog_to_blackhole ingress throughput -0.25 [-0.31, -0.18] 1 Logs
file_tree memory utilization -0.28 [-0.35, -0.21] 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_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.
  • 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.

@janine-c janine-c removed their assignment Feb 10, 2025
Copy link
Contributor

@dustmop dustmop left a comment

Choose a reason for hiding this comment

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

LGTM for agent-configuration

@DDuongNguyen
Copy link
Contributor Author

/merge

@dd-devflow
Copy link

dd-devflow bot commented Feb 12, 2025

View all feedbacks in Devflow UI.
2025-02-12 20:05:27 UTC ℹ️ Start processing command /merge


2025-02-12 20:05:30 UTC ℹ️ MergeQueue: pull request added to the queue

The median merge time in main is 32m.


2025-02-12 20:42:47 UTC ℹ️ MergeQueue: This merge request was merged

@dd-mergequeue dd-mergequeue bot merged commit 5b00e94 into main Feb 12, 2025
225 checks passed
@dd-mergequeue dd-mergequeue bot deleted the yoon/log-compression-validation branch February 12, 2025 20:42
@github-actions github-actions bot added this to the 7.64.0 milestone Feb 12, 2025
@rahulkaukuntla rahulkaukuntla removed their request for review February 13, 2025 15:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
changelog/no-changelog medium review PR review might take time qa/done QA done before merge and regressions are covered by tests team/agent-log-pipelines
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants