Use json-iterator for secrets marshalling#44309
Conversation
If my datadog.yaml config contains this:
```
secret_backend_command: /opt/datadog-agent/scripts/script.py
secret_backend_type: aws.secrets
secret_backend_config:
a:
b: c
api_key: ENC[my_api_key]
```
Then running this code with `DD_CONF_NODETREEMODEL=enable` leads to `b: c` having type `map[interface{}]interface{}` which `encoding/json` fails to marshal. The third-party package `"github.com/json-iterator/go"` will correctly marshal this.
Go Package Import DifferencesBaseline: 5050bc2
|
Static quality checks✅ Please find below the results from static quality gates Successful checksInfo
|
Regression DetectorRegression Detector ResultsMetrics dashboard Baseline: f8046ec Optimization Goals: ✅ No significant changes detected
|
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | +0.77 | [-2.27, +3.82] | 1 | Logs |
Fine details of change detection per experiment
| perf | experiment | goal | Δ mean % | Δ mean % CI | trials | links |
|---|---|---|---|---|---|---|
| ➖ | docker_containers_cpu | % cpu utilization | +0.77 | [-2.27, +3.82] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulativetodelta_exporter | memory utilization | +0.48 | [+0.25, +0.71] | 1 | Logs |
| ➖ | quality_gate_logs | % cpu utilization | +0.42 | [-1.06, +1.91] | 1 | Logs bounds checks dashboard |
| ➖ | quality_gate_idle | memory utilization | +0.40 | [+0.36, +0.45] | 1 | Logs bounds checks dashboard |
| ➖ | uds_dogstatsd_20mb_12k_contexts_20_senders | memory utilization | +0.28 | [+0.22, +0.33] | 1 | Logs |
| ➖ | file_tree | memory utilization | +0.20 | [+0.14, +0.27] | 1 | Logs |
| ➖ | ddot_metrics_sum_delta | memory utilization | +0.20 | [-0.00, +0.41] | 1 | Logs |
| ➖ | quality_gate_idle_all_features | memory utilization | +0.20 | [+0.16, +0.23] | 1 | Logs bounds checks dashboard |
| ➖ | otlp_ingest_metrics | memory utilization | +0.12 | [-0.03, +0.28] | 1 | Logs |
| ➖ | file_to_blackhole_500ms_latency | egress throughput | +0.06 | [-0.31, +0.44] | 1 | Logs |
| ➖ | file_to_blackhole_100ms_latency | egress throughput | +0.02 | [-0.03, +0.07] | 1 | Logs |
| ➖ | file_to_blackhole_1000ms_latency | egress throughput | +0.02 | [-0.41, +0.44] | 1 | Logs |
| ➖ | file_to_blackhole_0ms_latency | egress throughput | +0.01 | [-0.38, +0.41] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api | ingress throughput | +0.01 | [-0.12, +0.14] | 1 | Logs |
| ➖ | uds_dogstatsd_to_api_v3 | ingress throughput | +0.01 | [-0.13, +0.14] | 1 | Logs |
| ➖ | tcp_dd_logs_filter_exclude | ingress throughput | -0.00 | [-0.08, +0.07] | 1 | Logs |
| ➖ | otlp_ingest_logs | memory utilization | -0.03 | [-0.12, +0.06] | 1 | Logs |
| ➖ | ddot_metrics_sum_cumulative | memory utilization | -0.22 | [-0.39, -0.05] | 1 | Logs |
| ➖ | docker_containers_memory | memory utilization | -0.26 | [-0.34, -0.18] | 1 | Logs |
| ➖ | ddot_metrics | memory utilization | -0.33 | [-0.56, -0.11] | 1 | Logs |
| ➖ | ddot_logs | memory utilization | -0.36 | [-0.43, -0.30] | 1 | Logs |
| ➖ | tcp_syslog_to_blackhole | ingress throughput | -0.40 | [-0.50, -0.30] | 1 | Logs |
| ➖ | quality_gate_metrics_logs | memory utilization | -1.96 | [-2.17, -1.75] | 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_1000ms_latency | lost_bytes | 10/10 | |
| ✅ | file_to_blackhole_1000ms_latency | 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_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 |
| ✅ | quality_gate_metrics_logs | cpu_usage | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | intake_connections | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_logs | lost_bytes | 10/10 | bounds checks dashboard |
| ✅ | quality_gate_metrics_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:
-
Its estimated |Δ mean %| ≥ 5.00%, indicating the change is big enough to merit a closer look.
-
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.
-
Its configuration does not mark it "erratic".
CI Pass/Fail Decision
✅ Passed. All Quality Gates passed.
- quality_gate_idle_all_features, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle_all_features, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check lost_bytes: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_metrics_logs, bounds check cpu_usage: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check intake_connections: 10/10 replicas passed. Gate passed.
- quality_gate_idle, bounds check memory_usage: 10/10 replicas passed. Gate passed.
- quality_gate_logs, 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.
|
/merge |
|
View all feedbacks in Devflow UI.
The expected merge time in
|
### What does this PR do?
Use json-iterator for secrets marshalling in the file `comp/core/secrets/impl/fetch_secret.go`
### Motivation
If my `datadog.yaml config` contains this:
```
secret_backend_command: /opt/datadog-agent/scripts/script.py
secret_backend_type: aws.secrets
secret_backend_config:
a:
b: c
api_key: ENC[my_api_key]
```
Then running this code with `DD_CONF_NODETREEMODEL=enable` leads to `b: c` having type `map[interface{}]interface{}` which `encoding/json` fails to marshal. The third-party package `"github.com/json-iterator/go"` will correctly marshal this.
### Describe how you validated your changes
### Additional Notes
It's unclear why enabling NTM causes this different runtime type. It could be a good idea to make sure the yaml reader never returns objects of type `map[interface{}]interface{}`.
Co-authored-by: dustin.long <dustin.long@datadoghq.com>
What does this PR do?
Use json-iterator for secrets marshalling in the file
comp/core/secrets/impl/fetch_secret.goMotivation
If my
datadog.yaml configcontains this:Then running this code with
DD_CONF_NODETREEMODEL=enableleads tob: chaving typemap[interface{}]interface{}whichencoding/jsonfails to marshal. The third-party package"github.com/json-iterator/go"will correctly marshal this.Describe how you validated your changes
Additional Notes
It's unclear why enabling NTM causes this different runtime type. It could be a good idea to make sure the yaml reader never returns objects of type
map[interface{}]interface{}.