Skip to content

ndm: make sure github.com/invopop/jsonschema is not in the final binary #36981

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

paulcacheux
Copy link
Contributor

@paulcacheux paulcacheux commented May 14, 2025

What does this PR do?

This PR moves all the methods related to json schema from pkg/networkdevice/profile/profiledefinition to a separate file, build gates under the jsonschema build tag. It then uses this build tag in the schema generator command.

The main goal of this change is to keep the exact same functionality (json schema generation) while removing the invopop/jsonschema from the agent binary, resulting in a nice dependency count reduction.

Motivation

Describe how you validated your changes

Possible Drawbacks / Trade-offs

Additional Notes

@github-actions github-actions bot added team/ndm-core medium review PR review might take time labels May 14, 2025
Copy link

cit-pr-commenter bot commented May 14, 2025

Go Package Import Differences

Baseline: 96e38c9
Comparison: 5e53ad5

binaryosarchchange
agentlinuxamd64
+0, -4
-github.com/bahlo/generic-list-go
-github.com/buger/jsonparser
-github.com/invopop/jsonschema
-github.com/wk8/go-ordered-map/v2
agentlinuxarm64
+0, -4
-github.com/bahlo/generic-list-go
-github.com/buger/jsonparser
-github.com/invopop/jsonschema
-github.com/wk8/go-ordered-map/v2
agentwindowsamd64
+0, -4
-github.com/bahlo/generic-list-go
-github.com/buger/jsonparser
-github.com/invopop/jsonschema
-github.com/wk8/go-ordered-map/v2
agentdarwinamd64
+0, -4
-github.com/bahlo/generic-list-go
-github.com/buger/jsonparser
-github.com/invopop/jsonschema
-github.com/wk8/go-ordered-map/v2
agentdarwinarm64
+0, -4
-github.com/bahlo/generic-list-go
-github.com/buger/jsonparser
-github.com/invopop/jsonschema
-github.com/wk8/go-ordered-map/v2
iot-agentlinuxamd64
+0, -12
-github.com/bahlo/generic-list-go
-github.com/buger/jsonparser
-github.com/invopop/jsonschema
-github.com/mailru/easyjson/buffer
-github.com/mailru/easyjson/jwriter
-github.com/wk8/go-ordered-map/v2
-go/ast
-go/build/constraint
-go/doc
-go/doc/comment
-go/parser
-go/scanner
iot-agentlinuxarm64
+0, -12
-github.com/bahlo/generic-list-go
-github.com/buger/jsonparser
-github.com/invopop/jsonschema
-github.com/mailru/easyjson/buffer
-github.com/mailru/easyjson/jwriter
-github.com/wk8/go-ordered-map/v2
-go/ast
-go/build/constraint
-go/doc
-go/doc/comment
-go/parser
-go/scanner
heroku-agentlinuxamd64
+0, -12
-github.com/bahlo/generic-list-go
-github.com/buger/jsonparser
-github.com/invopop/jsonschema
-github.com/mailru/easyjson/buffer
-github.com/mailru/easyjson/jwriter
-github.com/wk8/go-ordered-map/v2
-go/ast
-go/build/constraint
-go/doc
-go/doc/comment
-go/parser
-go/scanner
cluster-agentlinuxamd64
+0, -4
-github.com/bahlo/generic-list-go
-github.com/buger/jsonparser
-github.com/invopop/jsonschema
-github.com/wk8/go-ordered-map/v2
cluster-agentlinuxarm64
+0, -4
-github.com/bahlo/generic-list-go
-github.com/buger/jsonparser
-github.com/invopop/jsonschema
-github.com/wk8/go-ordered-map/v2

@paulcacheux paulcacheux added changelog/no-changelog qa/done QA done before merge and regressions are covered by tests labels May 14, 2025
@paulcacheux paulcacheux force-pushed the paulcacheux/remove-invopop branch from 60bdbc9 to a8171a0 Compare May 14, 2025 15:50
@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented May 14, 2025

Uncompressed package size comparison

Comparison with ancestor f3e0381b6de8ea5570594c8ddce9904fdb151d42

Size reduction summary
package diff status size ancestor threshold
datadog-agent-aarch64-rpm -0.16MB 768.17MB 768.33MB 0.50MB
datadog-agent-arm64-deb -0.16MB 759.24MB 759.40MB 0.50MB
datadog-agent-amd64-deb -0.16MB 773.29MB 773.45MB 0.50MB
datadog-agent-x86_64-rpm -0.16MB 782.24MB 782.40MB 0.50MB
datadog-agent-x86_64-suse -0.16MB 782.24MB 782.40MB 0.50MB
datadog-iot-agent-aarch64-rpm -0.17MB 59.28MB 59.45MB 0.50MB
datadog-iot-agent-arm64-deb -0.17MB 59.20MB 59.37MB 0.50MB
datadog-heroku-agent-amd64-deb -0.17MB 380.01MB 380.17MB 0.50MB
datadog-iot-agent-amd64-deb -0.17MB 62.62MB 62.79MB 0.50MB
datadog-iot-agent-x86_64-rpm -0.17MB 62.71MB 62.88MB 0.50MB
datadog-iot-agent-x86_64-suse -0.17MB 62.71MB 62.87MB 0.50MB
Diff per package
package diff status size ancestor threshold
datadog-dogstatsd-amd64-deb 0.00MB 31.99MB 31.99MB 0.50MB
datadog-dogstatsd-x86_64-rpm 0.00MB 32.07MB 32.07MB 0.50MB
datadog-dogstatsd-x86_64-suse 0.00MB 32.07MB 32.07MB 0.50MB
datadog-dogstatsd-arm64-deb 0.00MB 30.47MB 30.47MB 0.50MB

Decision

✅ Passed

Copy link

cit-pr-commenter bot commented May 14, 2025

Regression Detector

Regression Detector Results

Metrics dashboard
Target profiles
Run ID: 71cfc643-2221-4d27-9bdd-042846a9a210

Baseline: 96e38c9
Comparison: 5e53ad5
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.65 [+0.80, +2.50] 1 Logs
file_tree memory utilization +1.51 [+1.34, +1.68] 1 Logs
docker_containers_cpu % cpu utilization +1.13 [-1.94, +4.20] 1 Logs
docker_containers_memory memory utilization +0.97 [+0.90, +1.03] 1 Logs
tcp_syslog_to_blackhole ingress throughput +0.56 [+0.50, +0.62] 1 Logs
ddot_metrics memory utilization +0.53 [+0.41, +0.65] 1 Logs
ddot_logs memory utilization +0.43 [+0.29, +0.57] 1 Logs
uds_dogstatsd_20mb_12k_contexts_20_senders memory utilization +0.28 [+0.23, +0.33] 1 Logs
quality_gate_idle memory utilization +0.19 [+0.13, +0.25] 1 Logs bounds checks dashboard
otlp_ingest_logs memory utilization +0.19 [+0.06, +0.32] 1 Logs
file_to_blackhole_0ms_latency egress throughput +0.17 [-0.43, +0.76] 1 Logs
file_to_blackhole_0ms_latency_http2 egress throughput +0.08 [-0.53, +0.68] 1 Logs
file_to_blackhole_500ms_latency egress throughput +0.08 [-0.53, +0.69] 1 Logs
file_to_blackhole_0ms_latency_http1 egress throughput +0.08 [-0.51, +0.66] 1 Logs
file_to_blackhole_1000ms_latency egress throughput +0.02 [-0.56, +0.60] 1 Logs
file_to_blackhole_100ms_latency egress throughput +0.02 [-0.56, +0.61] 1 Logs
file_to_blackhole_300ms_latency egress throughput +0.02 [-0.57, +0.61] 1 Logs
file_to_blackhole_1000ms_latency_linear_load egress throughput +0.02 [-0.22, +0.25] 1 Logs
uds_dogstatsd_to_api ingress throughput -0.01 [-0.28, +0.27] 1 Logs
tcp_dd_logs_filter_exclude ingress throughput -0.01 [-0.03, +0.01] 1 Logs
otlp_ingest_metrics memory utilization -0.03 [-0.20, +0.15] 1 Logs
quality_gate_logs % cpu utilization -0.03 [-2.75, +2.69] 1 Logs bounds checks dashboard
quality_gate_idle_all_features memory utilization -0.05 [-0.14, +0.03] 1 Logs bounds checks dashboard

Bounds Checks: ✅ Passed

perf experiment bounds_check_name replicates_passed links
docker_containers_cpu simple_check_run 10/10
docker_containers_memory memory_usage 10/10
docker_containers_memory simple_check_run 10/10
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 bounds checks dashboard
quality_gate_logs lost_bytes 10/10 bounds checks dashboard
quality_gate_logs memory_usage 10/10 bounds checks dashboard

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 intake_connections: 10/10 replicas passed. Gate passed.
  • quality_gate_logs, bounds check lost_bytes: 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.

@agent-platform-auto-pr
Copy link
Contributor

agent-platform-auto-pr bot commented May 14, 2025

Static quality checks

✅ Please find below the results from static quality gates
Comparison made with ancestor 96e38c9

Successful checks

Info

Quality gate Delta On disk size (MiB) Delta On wire size (MiB)
agent_deb_amd64 $${-0.08}$$ $${695.97}$$ < $${752.99}$$ $${+0.03}$$ $${176.01}$$ < $${187.44}$$
agent_deb_amd64_fips $${-0.08}$$ $${694.21}$$ < $${751.36}$$ $${-0.03}$$ $${175.45}$$ < $${187.06}$$
agent_heroku_amd64 $${-0.09}$$ $${358.47}$$ < $${369.68}$$ $${-0.03}$$ $${96.47}$$ < $${99.55}$$
agent_msi $${-0.56}$$ $${959.31}$$ < $${987.01}$$ $${-0.05}$$ $${146.38}$$ < $${150.72}$$
agent_rpm_amd64 $${-0.08}$$ $${695.96}$$ < $${752.98}$$ $${-0.02}$$ $${177.52}$$ < $${190.03}$$
agent_rpm_amd64_fips $${-0.08}$$ $${694.2}$$ < $${751.35}$$ $${-0.05}$$ $${177.38}$$ < $${189.81}$$
agent_rpm_arm64 $${-0.08}$$ $${685.92}$$ < $${739.42}$$ $${-0.01}$$ $${161.0}$$ < $${171.23}$$
agent_rpm_arm64_fips $${-0.08}$$ $${684.27}$$ < $${737.91}$$ $${+0}$$ $${160.08}$$ < $${170.22}$$
agent_suse_amd64 $${-0.08}$$ $${695.96}$$ < $${752.98}$$ $${-0.02}$$ $${177.52}$$ < $${190.03}$$
agent_suse_amd64_fips $${-0.08}$$ $${694.2}$$ < $${751.35}$$ $${-0.05}$$ $${177.38}$$ < $${189.81}$$
agent_suse_arm64 $${-0.08}$$ $${685.92}$$ < $${739.42}$$ $${-0.01}$$ $${161.0}$$ < $${171.23}$$
agent_suse_arm64_fips $${-0.08}$$ $${684.27}$$ < $${737.91}$$ $${+0}$$ $${160.08}$$ < $${170.22}$$
docker_agent_amd64 $${-0.08}$$ $${779.76}$$ < $${849.39}$$ $${-0.01}$$ $${268.58}$$ < $${288.34}$$
docker_agent_arm64 $${-0.08}$$ $${793.17}$$ < $${858.97}$$ $${-0.04}$$ $${255.94}$$ < $${274.36}$$
docker_agent_jmx_amd64 $${-0.08}$$ $${779.76}$$ < $${849.39}$$ $${-0.01}$$ $${268.58}$$ < $${288.34}$$
docker_agent_jmx_arm64 $${-0.08}$$ $${793.17}$$ < $${858.97}$$ $${-0.04}$$ $${255.94}$$ < $${274.36}$$
docker_agent_windows1809 $${-0.08}$$ $${779.76}$$ < $${849.39}$$ $${-0.01}$$ $${268.58}$$ < $${288.34}$$
docker_agent_windows1809_core $${-0.08}$$ $${779.76}$$ < $${849.39}$$ $${-0.01}$$ $${268.58}$$ < $${288.34}$$
docker_agent_windows1809_core_jmx $${-0.08}$$ $${779.76}$$ < $${849.39}$$ $${-0.01}$$ $${268.58}$$ < $${288.34}$$
docker_agent_windows1809_jmx $${-0.08}$$ $${779.76}$$ < $${849.39}$$ $${-0.01}$$ $${268.58}$$ < $${288.34}$$
docker_agent_windows2022 $${-0.08}$$ $${779.76}$$ < $${849.39}$$ $${-0.01}$$ $${268.58}$$ < $${288.34}$$
docker_agent_windows2022_core $${-0.08}$$ $${779.76}$$ < $${849.39}$$ $${-0.01}$$ $${268.58}$$ < $${288.34}$$
docker_agent_windows2022_core_jmx $${-0.08}$$ $${779.76}$$ < $${849.39}$$ $${-0.01}$$ $${268.58}$$ < $${288.34}$$
docker_agent_windows2022_jmx $${-0.08}$$ $${779.76}$$ < $${849.39}$$ $${-0.01}$$ $${268.58}$$ < $${288.34}$$
docker_cluster_agent_amd64 $${-0.22}$$ $${258.97}$$ < $${259.73}$$ $${-0.1}$$ $${102.78}$$ < $${103.68}$$
docker_cluster_agent_arm64 $${-0.2}$$ $${273.38}$$ < $${274.24}$$ $${-0.14}$$ $${97.47}$$ < $${98.45}$$
docker_cws_instrumentation_amd64 $${-0}$$ $${7.08}$$ < $${7.12}$$ $${-0}$$ $${2.95}$$ < $${3.29}$$
docker_cws_instrumentation_arm64 $${-0}$$ $${6.69}$$ < $${6.92}$$ $${0}$$ $${2.7}$$ < $${3.07}$$
docker_dogstatsd_amd64 $${+0}$$ $${38.93}$$ < $${39.57}$$ $${+0}$$ $${14.95}$$ < $${15.76}$$
docker_dogstatsd_arm64 $${0}$$ $${37.52}$$ < $${38.2}$$ $${+0}$$ $${13.96}$$ < $${14.83}$$
dogstatsd_deb_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${+0}$$ $${8.04}$$ < $${8.97}$$
dogstatsd_deb_arm64 $${0}$$ $${29.16}$$ < $${30.08}$$ $${+0}$$ $${6.98}$$ < $${7.92}$$
dogstatsd_rpm_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${+0}$$ $${8.04}$$ < $${8.98}$$
dogstatsd_suse_amd64 $${0}$$ $${30.61}$$ < $${31.52}$$ $${+0}$$ $${8.04}$$ < $${8.98}$$
iot_agent_deb_amd64 $${-0.1}$$ $${50.39}$$ < $${60.17}$$ $${-0.02}$$ $${12.82}$$ < $${15.82}$$
iot_agent_deb_arm64 $${-0.09}$$ $${47.85}$$ < $${56.94}$$ $${-0.02}$$ $${11.12}$$ < $${13.86}$$
iot_agent_deb_armhf $${-0.09}$$ $${47.43}$$ < $${56.41}$$ $${-0.03}$$ $${11.19}$$ < $${13.86}$$
iot_agent_rpm_amd64 $${-0.1}$$ $${50.39}$$ < $${60.18}$$ $${-0.03}$$ $${12.84}$$ < $${15.84}$$
iot_agent_rpm_arm64 $${-0.09}$$ $${47.85}$$ < $${56.94}$$ $${-0.02}$$ $${11.14}$$ < $${13.76}$$
iot_agent_suse_amd64 $${-0.1}$$ $${50.39}$$ < $${60.18}$$ $${-0.03}$$ $${12.84}$$ < $${15.84}$$

@paulcacheux paulcacheux force-pushed the paulcacheux/remove-invopop branch from a8171a0 to 265d825 Compare May 19, 2025 08:58
@paulcacheux paulcacheux force-pushed the paulcacheux/remove-invopop branch from 265d825 to 5d383d7 Compare May 26, 2025 12:55
@paulcacheux paulcacheux force-pushed the paulcacheux/remove-invopop branch from 5d383d7 to 5c82209 Compare June 7, 2025 18:23
@paulcacheux paulcacheux force-pushed the paulcacheux/remove-invopop branch from 5c82209 to 5e53ad5 Compare June 10, 2025 12:01
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/ndm-core
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant