-
Notifications
You must be signed in to change notification settings - Fork 11
Expand file tree
/
Copy pathschema_overlay.yaml
More file actions
4427 lines (4136 loc) · 240 KB
/
Copy pathschema_overlay.yaml
File metadata and controls
4427 lines (4136 loc) · 240 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
# Schema Overlay: the single source of truth file for managing Saluki's Datadog config inventory.
#
# This file lives side-by-side with the vendored Datadog Agent configuration schema. Every
# config key that exists in the schema must be represented here in the overlay. Validation happens
# during and after deserialization during build and tooling processes.
#
# There are two sections that must appear in the correct order:
# - inventory: every key the team has reviewed and classified
# - excluded: keys that ADP/Saluki intentionally and silently ignores
#
# Each inventory entry is tagged with a `support` field:
# - full: ADP reads and fully supports this key; behavior matches the core Agent
# - partial: ADP reads this key but behavior diverges in some cases
# - none: ADP does not support this key
# - unknown: ADP's compatibility with this key has not yet been determined
#
# Rust code and Markdown documentation are generated from the contents of this file. Your edits here
# have consequences downstream as follows (see the generator code to be certain):
#
# support: full -> runtime classifier: Full; docs: "Transparent Settings" table
#
# support: partial -> runtime classifier: Partial; docs: "Behavioral Differences"
# table; multi-line documentation renders as a detail block
# below the table
#
# support: none + planned -> runtime classifier: Incompatible(severity); docs: "Being
# Worked On" table; issue required
#
# support: none + !planned -> runtime classifier: Incompatible(severity); docs: "Not
# Planned" table; single-line documentation fills the "Reason"
# column; multi-line renders as a detail block below the table
#
# support: unknown + severity -> runtime classifier: Incompatible(severity, cross_cutting);
# docs: "Compatibility Unknown" table
#
# support: unknown (no sev) -> no classifier entry (docs-only); "Compatibility Unknown"
# table
#
# excluded -> no classifier entry; no docs table entry
#
# Validation rules are somewhat complex. For complete rules, see the code in `config-overlay-model`,
# but here are some of the basics:
#
# - support: none + planned: true requires issue; the build rejects entries that omit it
# - pipelines: [cross_cutting] must appear alone; cross_cutting mixed with other tokens is rejected
# - support: unknown entries without severity produce no runtime classifier entry and are docs-only
inventory:
additional_endpoints:
support: full
pipelines: [cross_cutting]
description: "Dual-ship to extra endpoints"
test_support:
used_by: [DatadogMetricsConfiguration, ForwarderConfiguration]
test_json: '{"smoke-host-1.example.com": ["smoke-api-key"]}'
additional_attributes:
config_registry_filename: forwarder.rs
agent_ipc.grpc_max_message_size:
support: full
pipelines: [cross_cutting]
description: "Max inbound gRPC message size for IPC client"
test_support:
used_by: [RemoteAgentClientConfiguration]
test_json: "4194304"
additional_attributes:
config_registry_filename: get_typed.rs
aggregator_buffer_size:
support: none
severity: low
planned: false
pipelines: [dogstatsd]
description: "Channel buffer depth for aggregator queues"
documentation: |-
The core Agent uses `aggregator_buffer_size` to size bounded Go channels feeding the aggregator and
DogStatsD time sampler workers.
ADP has no equivalent operator-facing setting. Its aggregate transform receives data through the
Saluki topology interconnects, which are configured at topology construction time rather than by
per-component Agent config keys. The default event interconnect capacity is 128 buffers, and each
event buffer can hold up to 1024 events.
Setting `aggregator_buffer_size` has no effect in ADP.
issue: "#1681"
aggregator_flush_metrics_and_serialize_in_parallel_buffer_size:
support: none
severity: low
planned: false
pipelines: [dogstatsd]
description: "Parallel flush: series/sketch buffer size"
documentation: |-
The core Agent uses `aggregator_flush_metrics_and_serialize_in_parallel_buffer_size` during
aggregator flushes, not for the aggregator's input queues. It controls how many flushed
series or sketch objects are grouped into each internal buffered-channel slice while one
goroutine produces flushed metrics and another goroutine serializes them.
ADP has no equivalent flush-and-serialize iterable pipeline. The aggregate transform emits
aggregated `Metric` events into the Saluki topology through `EventsBuffer` batches, and
downstream encoder components serialize those events independently of the aggregate transform.
The closest internal ADP buffering is topology-wide: `EventsBuffer` can hold up to 1024 events,
and event interconnects default to 128 buffers. These are not configured through
`aggregator_flush_metrics_and_serialize_in_parallel_buffer_size`, and setting this key has no
effect in ADP.
issue: "#1681"
aggregator_flush_metrics_and_serialize_in_parallel_chan_size:
support: none
severity: low
planned: false
pipelines: [dogstatsd]
description: "Parallel flush: channel size"
documentation: |-
The core Agent uses `aggregator_flush_metrics_and_serialize_in_parallel_chan_size` during
aggregator flushes, together with
`aggregator_flush_metrics_and_serialize_in_parallel_buffer_size`. The buffer size controls how
many flushed series or sketch objects are grouped into each internal slice, while the channel
size controls how many of those slices can queue between the flush producer goroutine and the
consumer goroutine that serializes them.
ADP has no equivalent flush-and-serialize iterable pipeline. The aggregate transform emits
aggregated `Metric` events into the Saluki topology through `EventsBuffer` batches, and
downstream encoder components serialize those events independently of the aggregate transform.
The closest internal ADP buffering is topology-wide: `EventsBuffer` can hold up to 1024 events,
and event interconnects default to 128 buffers. These are not configured through
`aggregator_flush_metrics_and_serialize_in_parallel_chan_size`, and setting this key has no
effect in ADP.
issue: "#1681"
aggregator_stop_timeout:
support: partial
pipelines: [cross_cutting]
description: "Timeout (s) for aggregator flush on stop"
documentation: |-
The core Agent uses `aggregator_stop_timeout` as the shutdown grace period for the aggregator's
final flush. During shutdown, the core Agent tries to flush aggregated metrics, events, service
checks, and related data to the forwarder before stopping. If `dogstatsd_flush_incomplete_buckets`
is enabled, the same timeout also bounds draining in-flight DogStatsD time sampler batches before
that final flush.
ADP uses `aggregator_stop_timeout` together with `forwarder_stop_timeout` to configure its
topology-wide graceful shutdown timeout. The default is `2 + 2 = 4` seconds. Set
`data_plane.stop_timeout` to override the combined timeout directly.
Support is partial because ADP does not apply this timeout only to an aggregator component.
Shutdown is coordinated by the Saluki topology: sources stop first, downstream inputs close,
and the aggregate transform performs its final flush when its input stream ends. Whether open
aggregation windows are included is controlled by `aggregate_flush_open_windows`, also aliased
as `dogstatsd_flush_incomplete_buckets`.
issue: "#1681"
test_support:
used_by: [get_typed]
value_type_override: integer
additional_attributes:
config_registry_filename: get_typed.rs
aggregator_use_tags_store:
support: none
severity: low
planned: false
pipelines: [dogstatsd]
description: "Enable shared tag deduplication store"
documentation: |-
The core Agent uses `aggregator_use_tags_store` to enable an aggregator-local, ref-counted
tag store. The store deduplicates repeated tag slices across aggregator contexts: contexts
retain shared tag entries while active, release them when they expire, and periodic shrinking
removes entries that are no longer referenced.
ADP does not have an aggregator-local tag store and does not need this toggle. Metrics reach
the aggregate transform with Saluki `Context` values that already carry ADP-native tag
structures. Tag reuse is handled before aggregation by the context resolver, the tags resolver,
and `SharedTagSet` structural sharing.
Related ADP-specific tuning is exposed through context/tag-set resolver settings such as
`dogstatsd_cached_tagsets_limit`, not through `aggregator_use_tags_store`. Setting
`aggregator_use_tags_store` has no effect in ADP.
issue: "#1681"
allow_arbitrary_tags:
support: full
pipelines: [cross_cutting]
description: "Relax backend tag validation via HTTP header"
test_support:
used_by: [ForwarderConfiguration]
env_var_override: [DD_ALLOW_ARBITRARY_TAGS]
additional_attributes:
config_registry_filename: forwarder.rs
api_key:
support: full
pipelines: [cross_cutting]
description: "API key for endpoint auth"
test_support:
used_by: [ForwarderConfiguration]
additional_attributes:
config_registry_filename: forwarder.rs
apm_config.compute_stats_by_span_kind:
support: full
pipelines: [traces]
description: "Compute APM stats per span kind"
test_support:
used_by: [NO_SMOKE]
apm_config.enable_rare_sampler:
support: full
pipelines: [traces]
description: "Enable the APM rare-span sampler"
test_support:
used_by: [NO_SMOKE]
apm_config.error_tracking_standalone.enabled:
support: full
pipelines: [traces]
description: "Enable Error Tracking standalone"
test_support:
used_by: [NO_SMOKE]
apm_config.errors_per_second:
support: full
pipelines: [traces]
description: "APM error-span sampling rate (per sec)"
test_support:
used_by: [NO_SMOKE]
apm_config.obfuscation.credit_cards.enabled:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.credit_cards.enabled"
test_support:
used_by: [TypedConfigSystem]
test_json: "true"
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.credit_cards.keep_values:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.credit_cards.keep_values"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.credit_cards.luhn:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.credit_cards.luhn"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.elasticsearch.enabled:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.elasticsearch.enabled"
test_support:
used_by: [TypedConfigSystem]
test_json: "true"
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.elasticsearch.keep_values:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.elasticsearch.keep_values"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.elasticsearch.obfuscate_sql_values:
support: full
pipelines: [traces]
description: "Obfuscate SQL values in ES queries"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.http.remove_paths_with_digits:
support: full
pipelines: [traces]
description: "Strip numeric segments from HTTP paths"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.http.remove_query_string:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.http.remove_query_string"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.memcached.enabled:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.memcached.enabled"
test_support:
used_by: [TypedConfigSystem]
test_json: "true"
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.memcached.keep_command:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.memcached.keep_command"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.mongodb.enabled:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.mongodb.enabled"
test_support:
used_by: [TypedConfigSystem]
test_json: "true"
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.mongodb.keep_values:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.mongodb.keep_values"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.mongodb.obfuscate_sql_values:
support: full
pipelines: [traces]
description: "Obfuscate SQL values in MongoDB queries"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.opensearch.enabled:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.opensearch.enabled"
test_support:
used_by: [TypedConfigSystem]
test_json: "true"
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.opensearch.keep_values:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.opensearch.keep_values"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.opensearch.obfuscate_sql_values:
support: full
pipelines: [traces]
description: "Obfuscate SQL values in OpenSearch queries"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.redis.enabled:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.redis.enabled"
test_support:
used_by: [TypedConfigSystem]
test_json: "true"
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.redis.remove_all_args:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.redis.remove_all_args"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.valkey.enabled:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.valkey.enabled"
test_support:
used_by: [TypedConfigSystem]
test_json: "true"
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.obfuscation.valkey.remove_all_args:
support: full
pipelines: [traces]
description: "apm_config.obfuscation.valkey.remove_all_args"
test_support:
used_by: [TypedConfigSystem]
additional_attributes:
config_registry_filename: trace_obfuscation.rs
apm_config.peer_tags:
support: full
pipelines: [traces]
description: "Extra peer tags for stats aggregation"
test_support:
used_by: [NO_SMOKE]
apm_config.peer_tags_aggregation:
support: full
pipelines: [traces]
description: "Aggregate APM stats by peer tags"
test_support:
used_by: [NO_SMOKE]
apm_config.probabilistic_sampler.enabled:
support: full
pipelines: [traces]
description: "Enable APM probabilistic sampler"
test_support:
used_by: [NO_SMOKE]
apm_config.probabilistic_sampler.sampling_percentage:
support: full
pipelines: [traces]
description: "Probabilistic sampler percentage"
test_support:
used_by: [NO_SMOKE]
apm_config.target_traces_per_second:
support: full
pipelines: [traces]
description: "Target sampled traces per second"
test_support:
used_by: [NO_SMOKE]
autoscaling.failover.enabled:
support: full
pipelines: [checks, dogstatsd, otlp]
description: "Enable autoscaling failover metric routing"
test_support:
used_by: [get_typed]
test_json: "true"
additional_attributes:
config_registry_filename: get_typed.rs
autoscaling.failover.metrics:
support: full
pipelines: [checks, dogstatsd, otlp]
description: "Metric names forwarded to DCA for failover"
test_support:
used_by: [get_typed]
test_json: '["container.memory.usage"]'
additional_attributes:
config_registry_filename: get_typed.rs
basic_telemetry_add_container_tags:
support: full
pipelines: [cross_cutting]
description: "Add container tags to basic telemetry signals"
test_support:
used_by: [TypedConfigSystem]
test_json: "true"
additional_attributes:
config_registry_filename: data_plane.rs
bind_host:
support: full
pipelines: [dogstatsd]
description: "Global listen host fallback"
test_support:
used_by: [DogStatsDConfiguration]
additional_attributes:
config_registry_filename: dogstatsd.rs
cluster_agent.auth_token:
support: full
pipelines: [checks, dogstatsd, otlp]
description: "Bearer token for Cluster Agent requests"
test_support:
used_by: [get_typed]
test_json: '"cluster-agent-token"'
additional_attributes:
config_registry_filename: get_typed.rs
cluster_agent.enabled:
support: full
pipelines: [checks, dogstatsd, otlp]
description: "Enable Cluster Agent communication"
test_support:
used_by: [get_typed]
test_json: "true"
additional_attributes:
config_registry_filename: get_typed.rs
cluster_agent.kubernetes_service_name:
support: full
pipelines: [checks, dogstatsd, otlp]
description: "Cluster Agent Kubernetes service name"
test_support:
used_by: [get_typed]
test_json: '"datadog-cluster-agent"'
additional_attributes:
config_registry_filename: get_typed.rs
cluster_agent.url:
support: full
pipelines: [checks, dogstatsd, otlp]
description: "Cluster Agent HTTPS endpoint"
test_support:
used_by: [get_typed]
test_json: '"https://cluster-agent.example.com"'
additional_attributes:
config_registry_filename: get_typed.rs
cmd_port:
support: full
pipelines: [cross_cutting]
description: "Core Agent CMD API port for ADP gRPC IPC"
test_support:
used_by: [RemoteAgentClientConfiguration]
test_json: "5101"
additional_attributes:
config_registry_filename: get_typed.rs
config_id:
support: none
severity: low
planned: false
pipelines: [cross_cutting]
description: "Fleet Automation config ID tag"
documentation: "Core Agent uses this only on Agent HA telemetry metrics."
cri_connection_timeout:
support: full
pipelines: [cross_cutting]
description: "CRI container runtime connection timeout (s)"
test_support:
used_by: [ContainerdConfiguration]
additional_attributes:
config_registry_filename: containerd.rs
cri_query_timeout:
support: full
pipelines: [cross_cutting]
description: "CRI container runtime query timeout (s)"
test_support:
used_by: [ContainerdConfiguration]
additional_attributes:
config_registry_filename: containerd.rs
data_plane.api_listen_address:
support: full
pipelines: [cross_cutting]
description: "Unprivileged API listen address"
documentation: |-
This is the unprivileged (internal) API endpoint. Addresses must include a URL scheme
(for example, `tcp://`). See `data_plane.secure_api_listen_address` for the privileged
endpoint.
test_support:
used_by: [get_typed]
additional_attributes:
config_registry_filename: data_plane.rs
data_plane.dogstatsd.aggregator_tag_filter_cache_capacity:
support: full
pipelines: [dogstatsd]
description: "Tag-filter deduplication cache size"
test_support:
used_by: [TagFilterlistConfiguration]
value_type_override: integer
additional_attributes:
config_registry_filename: tag_filterlist.rs
data_plane.dogstatsd.enabled:
support: full
pipelines: [cross_cutting]
description: "Enable the DogStatsD pipeline"
test_support:
used_by: [NO_SMOKE]
data_plane.enabled:
support: full
pipelines: [cross_cutting]
description: "Enable the data plane"
test_support:
used_by: [NO_SMOKE]
data_plane.log_file:
support: full
pipelines: [cross_cutting]
description: "ADP log file path"
documentation: |-
ADP writes to its own log file, separate from the Core Agent. The Core Agent's `log_file`
key is deliberately not consulted. Set `disable_file_logging: true` to disable file logging
entirely, which causes this key to have no effect.
test_support:
used_by: [get_typed]
additional_attributes:
config_registry_filename: data_plane.rs
data_plane.otlp.enabled:
support: full
pipelines: [cross_cutting]
description: "Enable the OTLP pipeline"
test_support:
used_by: [NO_SMOKE]
data_plane.otlp.proxy.enabled:
support: full
pipelines: [otlp]
description: "Enable OTLP proxy to Core Agent"
test_support:
used_by: [NO_SMOKE]
data_plane.otlp.proxy.logs.enabled:
support: full
pipelines: [otlp]
description: "Proxy OTLP logs to Core Agent"
test_support:
used_by: [get_typed]
additional_attributes:
config_registry_filename: data_plane.rs
data_plane.otlp.proxy.metrics.enabled:
support: full
pipelines: [otlp]
description: "Proxy OTLP metrics to Core Agent"
test_support:
used_by: [get_typed]
additional_attributes:
config_registry_filename: data_plane.rs
data_plane.otlp.proxy.receiver.protocols.grpc.endpoint:
support: full
pipelines: [otlp]
description: "OTLP proxy gRPC receiver endpoint"
test_support:
used_by: [NO_SMOKE]
data_plane.otlp.proxy.traces.enabled:
support: full
pipelines: [otlp]
description: "Proxy OTLP traces to Core Agent"
test_support:
used_by: [get_typed]
additional_attributes:
config_registry_filename: data_plane.rs
data_plane.remote_agent_enabled:
support: full
pipelines: [cross_cutting]
description: "Enable remote agent mode"
documentation: |-
### `data_plane.remote_agent_enabled` / `data_plane.use_new_config_stream_endpoint`
These two keys are transitional flags being phased out. Both will be implied by
`data_plane.standalone_mode=false` in a future release. Do not rely on them for
new deployments.
test_support:
used_by: [get_typed]
additional_attributes:
config_registry_filename: data_plane.rs
data_plane.secure_api_listen_address:
support: full
pipelines: [cross_cutting]
description: "mTLS-authenticated privileged API address"
documentation: |-
### `data_plane.secure_api_listen_address`
This key configures the listener for the mTLS-authenticated privileged HTTP and gRPC API.
Addresses use a transport scheme (for example, `tcp://`) to select the underlying socket
type. See `data_plane.api_listen_address` for the unprivileged endpoint.
Before ADP routes a request, every client must present a certificate during the TLS
handshake. The presented leaf certificate's DER encoding must exactly equal the Agent IPC
certificate loaded from the configured `ipc_cert.pem`, and the handshake must prove
possession of its private key. An issuing CA does not broaden the accepted identity.
All clients use this same certificate and therefore share one principal; ADP does not
distinguish individual clients. Certificate rotation is exact-only: ADP accepts no old/new
certificate overlap. Coordinate replacement of `ipc_cert.pem` with restarts so every client
and the server use the same certificate.
test_support:
used_by: [get_typed]
additional_attributes:
config_registry_filename: data_plane.rs
data_plane.telemetry_enabled:
support: none
pipelines: [cross_cutting]
description: "ADP telemetry toggle"
severity: low
planned: false
documentation: |-
Deprecated. ADP previously read this key to enable its internal Prometheus telemetry
endpoint, but no longer does so. The key is silently ignored.
data_plane.telemetry_listen_addr:
support: none
pipelines: [cross_cutting]
description: "ADP telemetry listen address"
severity: low
planned: false
documentation: |-
Deprecated. ADP previously read this key to configure the address of its internal
Prometheus telemetry endpoint, but no longer does so. The key is silently ignored.
data_plane.use_new_config_stream_endpoint:
support: full
pipelines: [cross_cutting]
description: "Use new config stream endpoint"
documentation: "See `data_plane.remote_agent_enabled` above."
test_support:
used_by: [get_typed]
additional_attributes:
config_registry_filename: data_plane.rs
dd_url:
support: full
pipelines: [cross_cutting]
description: "Override intake endpoint URL"
test_support:
used_by: [DatadogMetricsConfiguration, ForwarderConfiguration]
additional_attributes:
config_registry_filename: forwarder.rs
disable_file_logging:
support: full
pipelines: [cross_cutting]
description: "Disable writing logs to a file"
test_support:
used_by: [NO_SMOKE]
dogstatsd_buffer_size:
support: full
pipelines: [dogstatsd]
description: "Receive buffer size (bytes)"
test_support:
used_by: [DogStatsDConfiguration]
value_type_override: integer
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_capture_depth:
support: full
pipelines: [dogstatsd]
description: "Traffic capture channel depth"
issue: "#1381"
test_support:
used_by: [DogStatsDConfiguration]
value_type_override: integer
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_capture_path:
support: full
pipelines: [dogstatsd]
description: "Traffic capture file location"
issue: "#1381"
test_support:
used_by: [DogStatsDConfiguration]
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_context_expiry_seconds:
support: full
pipelines: [dogstatsd]
description: "Context cache TTL (seconds)"
test_support:
used_by: [DogStatsDConfiguration]
value_type_override: integer
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_disable_verbose_logs:
support: full
pipelines: [dogstatsd]
description: "Suppress noisy parse error logs"
issue: "#1350"
test_support:
used_by: [DogStatsDConfiguration]
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_entity_id_precedence:
support: full
pipelines: [dogstatsd]
description: "Entity ID over auto-detection"
test_support:
used_by: [DogStatsDConfiguration]
env_var_override: [DD_DOGSTATSD_ENTITY_ID_PRECEDENCE]
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_eol_required:
support: full
pipelines: [dogstatsd]
description: "Require newline-terminated messages"
test_support:
used_by: [DogStatsDConfiguration]
test_json: '["udp"]'
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_experimental_http.enabled:
support: none
severity: high
planned: true
pipelines: [dogstatsd]
description: "Enable experimental HTTP/H2C DSD listener"
documentation: "Experimental HTTP path for pre-aggregated DogStatsD metrics; planned when the DogStatsD-over-HTTP work resumes."
issue: "#1682"
dogstatsd_experimental_http.listen_address:
support: none
severity: high
planned: true
pipelines: [dogstatsd]
description: "Bind address for experimental HTTP DSD listener"
documentation: "Experimental HTTP path for pre-aggregated DogStatsD metrics; planned when the DogStatsD-over-HTTP work resumes."
issue: "#1682"
dogstatsd_expiry_seconds:
support: full
pipelines: [dogstatsd]
description: "Counter value expiry (seconds)"
test_support:
used_by: [NO_SMOKE]
dogstatsd_flush_incomplete_buckets:
support: full
pipelines: [dogstatsd, checks]
description: "Flush open buckets on shutdown"
test_support:
used_by: [AggregateConfiguration]
additional_yaml_paths: [aggregate_flush_open_windows]
additional_attributes:
config_registry_filename: aggregate.rs
dogstatsd_host_socket_path:
support: none
severity: low
planned: false
pipelines: [dogstatsd]
description: "Host UDS socket dir for DSD"
documentation: "Not read by DSD server; admission controller only."
dogstatsd_log_file:
support: full
pipelines: [dogstatsd]
description: "DSD dedicated log file path"
test_support:
used_by: [DogStatsDDebugLogConfiguration]
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_log_file_max_rolls:
support: full
pipelines: [dogstatsd]
description: "DSD log file max roll count"
test_support:
used_by: [DogStatsDDebugLogConfiguration]
value_type_override: integer
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_log_file_max_size:
support: full
pipelines: [dogstatsd]
description: "DSD log file max size"
input_shape: string_or_integer
test_support:
used_by: [DogStatsDDebugLogConfiguration]
test_json: '"42MB"'
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_logging_enabled:
support: full
pipelines: [dogstatsd]
description: "Enables DSD metric logging"
documentation: |
ADP supports the core agent's DogStatsD metric debug log. To write this file, set
`dogstatsd_metrics_stats_enable: true`. `dogstatsd_logging_enabled` also must be `true`;
it defaults to `true`, so most configurations only need to enable
`dogstatsd_metrics_stats_enable`.
When `dogstatsd_logging_enabled` is `true`, ADP connects an extra DogStatsD destination
to the decoded metric stream. The destination writes one line per metric sample with the
metric name, tags, count, and last-seen time while `dogstatsd_metrics_stats_enable` is
`true`. When `dogstatsd_metrics_stats_enable` is `false`, the destination drains decoded
metrics and drops them. This lets runtime configuration changes start and stop the debug
log without rebuilding the topology.
The default `dogstatsd_log_file` path is
`/var/log/datadog/dogstatsd_info/dogstatsd-stats.log` on Linux and other Unix platforms,
`/opt/datadog-agent/logs/dogstatsd_info/dogstatsd-stats.log` on macOS, and
`%ProgramData%\datadog\logs\dogstatsd_info\dogstatsd-stats.log` on Windows.
This debug log differs from the `dogstatsd_capture_*` settings. The debug log records
decoded metric summaries after DogStatsD parsing. The capture settings record raw
DogStatsD traffic for packet-level investigation.
test_support:
used_by: [DogStatsDDebugLogConfiguration]
additional_attributes:
config_registry_filename: dogstatsd.rs
dogstatsd_mapper_cache_size:
support: partial
pipelines: [dogstatsd]
description: "Mapper result LRU cache size"
documentation: |
ADP and the core agent both cache mapper results to skip regex evaluation on repeat
metric names. With the default value of `1000`, and with any positive integer, behavior
matches the core agent: results are cached in an LRU keyed by the original metric name,
including a negative-cache entry for names that match no profile.
The two implementations diverge when this setting is `0`. In the core agent, `0` is
rejected by the underlying LRU library, which causes the entire mapper to be silently
disabled: mapping profiles configured by `dogstatsd_mapper_profiles` are not applied. In
ADP, `0` disables the result cache only; mapping profiles still run, so each metric pays
the regex evaluation cost without amortization.
If you previously set `dogstatsd_mapper_cache_size: 0` in the core agent to turn off the
mapper, clear `dogstatsd_mapper_profiles` instead when running ADP.
issue: "#1687"
test_support:
used_by: [DogStatsDMapperConfiguration]
value_type_override: integer
additional_attributes:
config_registry_filename: dogstatsd_mapper.rs
dogstatsd_mapper_profiles:
support: full
pipelines: [dogstatsd]
description: "Metric mapping profile definitions"
test_support:
used_by: [DogStatsDMapperConfiguration]
test_json: '[{"name":"test","prefix":"test.","mappings":[]}]'
additional_attributes:
config_registry_filename: dogstatsd_mapper.rs
dogstatsd_mem_based_rate_limiter.enabled:
support: none
severity: low
planned: false
pipelines: [dogstatsd]
description: "Memory-based rate limiter toggle"
documentation: |
The Core Agent exposes 11 keys under this prefix to apply backpressure when the Go
process approaches its memory limit. They work by manipulating Go's garbage collector
(`debug.SetGCPercent`, `debug.FreeOSMemory`), allocating a large heap ballast to adjust
GC heuristics, and blocking goroutines to slow packet ingestion. None of these mechanisms
have an equivalent in Rust, and ADP does not use a Go runtime.
ADP takes a different approach to the same problem using explicit static memory accounting
and a process-level RSS limit. All 11 `dogstatsd_mem_based_rate_limiter.*` keys are not
planned. See [Memory Management](../memory.md) for details.
dogstatsd_mem_based_rate_limiter.go_gc:
support: none
severity: low
planned: false
pipelines: [dogstatsd]
description: "Memory rate limiter GC percent"
documentation: "Go GC-specific; ADP uses `memory_limit` instead."
dogstatsd_mem_based_rate_limiter.high_soft_limit:
support: none
severity: low
planned: false
pipelines: [dogstatsd]
description: "Memory rate limiter high soft limit"
documentation: "Go GC-specific; ADP uses `memory_limit` instead."
dogstatsd_mem_based_rate_limiter.low_soft_limit:
support: none
severity: low
planned: false
pipelines: [dogstatsd]
description: "Memory rate limiter low soft limit"
documentation: "Go GC-specific; ADP uses `memory_limit` instead."
dogstatsd_mem_based_rate_limiter.memory_ballast:
support: none