-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Expand file tree
/
Copy pathcore_schema.yaml
More file actions
10483 lines (10326 loc) · 329 KB
/
Copy pathcore_schema.yaml
File metadata and controls
10483 lines (10326 loc) · 329 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: https://json-schema.org/draft/2020-12/schema
$id: https://raw.githubusercontent.com/DataDog/schema/main/agent/datadog.yaml.schema.json
title: DataDog Agent configuration schema
description: The schema to validate the datadog.yaml configuration for the DataDog
Agent
properties:
api_key:
node_type: setting
title: Basic Configuration
type: string
default: ''
visibility: public
description: |-
The Datadog API key used by your Agent to submit metrics and events to Datadog.
Create a new API key here: https://app.datadoghq.com/organization-settings/api-keys .
Read more about API keys here: https://docs.datadoghq.com/account_management/api-app-keys/#api-keys .
tags:
- template_section:Common
app_key:
node_type: setting
type: string
default: ''
visibility: public
description: |-
The application key used to access Datadog's programmatic API.
Create a new application key here: https://app.datadoghq.com/organization-settings/application-keys .
Read more about application keys here: https://docs.datadoghq.com/account_management/api-app-keys/#application-keys .
tags:
- template_section:Common
site:
node_type: setting
type: string
default: datadoghq.com
visibility: public
description: |-
The site of the Datadog intake to send Agent data to.
The site parameter must be set to enable your agent with Remote Configuration.
Set to 'datadoghq.eu' to send data to the EU site.
Set to 'us3.datadoghq.com' to send data to the US3 site.
Set to 'us5.datadoghq.com' to send data to the US5 site.
Set to 'ap1.datadoghq.com' to send data to the AP1 site.
Set to 'ddog-gov.com' to send data to the US1-FED site.
tags:
- template_section:Common
infrastructure_mode:
node_type: setting
type: string
default: full
visibility: public
description: |-
Controls which integrations and metadata the Agent collects.
Valid values:
- full: default server/host-monitoring behavior (all checks allowed).
- basic: minimal host-level metrics only.
- end_user_device: tuned for end-user-device (EUDM) laptops and desktops.
- cloud_cost_only: Cloud Cost Management lightweight tagging.
- none: disables infrastructure checks.
tags:
- template_section:Common
comment: |-
Infrastructure mode
The infrastructure mode is used to determine the features that are available to the agent.
The possible values are: full, basic, end_user_device, cloud_cost_only, none.
dd_url:
node_type: setting
type: string
default: https://app.datadoghq.com
env_vars:
- DD_DD_URL
- DD_URL
visibility: public
description: |-
The host of the Datadog intake server to send metrics to, only set this option
if you need the Agent to send metrics to a custom URL, it overrides the site
setting defined in "site". It does not affect APM, Logs, Remote Configuration, or Live Process intake which have their
own "*_dd_url" settings.
If DD_DD_URL and DD_URL are both set, DD_DD_URL is used in priority.
tags:
- template_section:Common
proxy:
node_type: section
type: object
visibility: public
description: |-
If you need a proxy to connect to the Internet, provide it here (default:
disabled). Refer to https://docs.datadoghq.com/agent/proxy/ to understand how to use these settings.
For Logs proxy information, refer to https://docs.datadoghq.com/agent/proxy/#proxy-for-logs
tags:
- template_section:Common
properties:
https:
node_type: setting
type: string
default: ''
visibility: public
description: |-
@env DD_PROXY_HTTPS - string - optional - default: ""
The proxy to use for HTTPS requests
example: http://<USERNAME>:<PASSWORD>@<PROXY_SERVER_FOR_HTTPS>:<PORT>
tags:
- no-env
http:
node_type: setting
type: string
default: ''
visibility: public
description: |-
@env DD_PROXY_HTTP - string - optional - default: ""
The proxy to use for HTTP requests
example: http://<USERNAME>:<PASSWORD>@<PROXY_SERVER_FOR_HTTP>:<PORT>
tags:
- no-env
no_proxy:
node_type: setting
type: array
default: []
items:
type: string
visibility: public
description: |-
@env DD_PROXY_NO_PROXY - space-separated list of strings - optional - default: []
A list of hosts for which the proxy setting should not be used
example: |2-
- <HOSTNAME-1>
- <HOSTNAME-2>
tags:
- no-env
skip_ssl_validation:
node_type: setting
type: boolean
default: false
visibility: public
description: Setting this option to "true" tells the Agent to skip validation
of SSL/TLS certificates.
tags:
- template_section:Common
sslkeylogfile:
node_type: setting
type: string
default: ''
visibility: public
description: |-
sslkeylogfile specifies a destination for TLS master secrets
in NSS key log format to allow external programs
such as Wireshark to decrypt TLS connections.
For more details, see https://developer.mozilla.org/en-US/docs/Mozilla/Projects/NSS/Key_Log_Format.
Use of sslkeylogfile compromises security and should only be
used for debugging.
tags:
- template_section:Common
min_tls_version:
node_type: setting
type: string
default: tlsv1.2
visibility: public
description: |-
This option defines the minimum TLS version that will be used when
submitting data to the Datadog intake specified in "site" or "dd_url".
This parameter defaults to "tlsv1.2".
Possible values are: tlsv1.0, tlsv1.1, tlsv1.2, tlsv1.3; values are case-
insensitive.
tags:
- template_section:Common
comment: Configuration for TLS for outgoing connections
hostname:
node_type: setting
type: string
default: ''
visibility: public
description: Force the hostname name for the Agent. By default, the Agent auto-detects
its hostname.
example: <HOSTNAME_NAME>
tags:
- template_section:Common
hostname_file:
node_type: setting
type: string
default: ''
visibility: public
description: |-
In some environments, auto-detection of the hostname is not adequate and
environment variables cannot be used to set the value. In such cases, the
file on the host can also be used provide an appropriate value. If
'hostname' value has been set to a non-empty value, this option is ignored.
example: /var/lib/cloud/data/instance-id
tags:
- template_section:Common
hostname_fqdn:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
When the Agent relies on the OS to determine the hostname, make it use the
FQDN instead of the short hostname. Recommended value: true
More information at https://dtdg.co/flag-hostname-fqdn
tags:
- template_section:Common
- full-agent-only:true
comment: |-
if/when the default is changed to true, make the default platform
dependent; default should remain false on Windows to maintain backward
compatibility with Agent5 behavior/win
hostname_trust_uts_namespace:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
By default the Agent does not trust the hostname value retrieved from non-root UTS namespace,
as it's usually a generated name, unrelated to the host (e.g. when running in a container).
When enabled, the Agent will trust the value retrieved from non-root UTS namespace instead of failing
hostname resolution.
(Linux only)
tags:
- template_section:Common
- full-agent-only:true
comment: |-
By default the Agent does not trust the hostname value retrieved from non-root UTS namespace.
When enabled, the Agent will trust the value retrieved from non-root UTS namespace instead of failing
hostname resolution.
(Linux only)
host_aliases:
node_type: setting
type: array
default: []
items:
type: string
visibility: public
description: |-
List of host aliases to report in addition to any aliases collected
automatically from cloud providers.
More information at
https://docs.datadoghq.com/agent/faq/how-datadog-agent-determines-the-hostname/?tab=agentv6v7#host-aliases
example: |2-
- <ALIAS-1>
- <ALIAS-2>
tags:
- template_section:Common
- full-agent-only:true
tags:
node_type: setting
type: array
default: []
items:
type: string
visibility: public
description: |-
List of host tags. Attached in-app to every metric, event, log, trace, and service check emitted by this Agent.
This configuration value merges with `DD_EXTRA_TAGS`, allowing some
tags to be set in a configuration file (`tags`), and additional tags to be added
with an environment variable (`DD_EXTRA_TAGS`).
Learn more about tagging: https://docs.datadoghq.com/tagging/
example: |2-
- team:infra
- <TAG_KEY>:<TAG_VALUE>
tags:
- template_section:Common
extra_tags:
node_type: setting
type: array
default: []
items:
type: string
visibility: public
description: |-
List of host tags. Attached in-app to every metric, event, log, trace, and service check emitted by this Agent.
This configuration value merges with `tags`, allowing some
tags to be set in a configuration file (`tags`), and additional tags to be added
with an environment variable (`DD_EXTRA_TAGS`).
Learn more about tagging: https://docs.datadoghq.com/tagging/
example: |2-
- region:northerly
- <TAG_KEY>:<TAG_VALUE>
tags:
- template_section:Common
env:
node_type: setting
type: string
default: ''
visibility: public
description: |-
The environment name where the agent is running. Attached in-app to every
metric, event, log, trace, and service check emitted by this Agent.
example: <environment name>
tags:
- template_section:Common
remote_updates:
node_type: setting
type: boolean
default: true
visibility: public
description: Enable remote upgrades and configuration changes for the Agent.
tags:
- template_section:Common
- full-agent-only:true
comment: Installer configuration
process_manager:
node_type: section
type: object
visibility: public
description: |-
When true (see `enabled` below), the Datadog process manager daemon (dd-procmgrd) is enabled for this host install.
On Windows, the core Agent starts the Windows service `dd-procmgr-service` when this option is true.
On Linux, dd-procmgrd is started by systemd (`datadog-agent-procmgr.service` linked to the main Agent unit);
This setting is ignored on Linux and does not enable or disable the systemd unit.
tags:
- template_section:Common
properties:
enabled:
node_type: setting
type: boolean
default: true
visibility: public
description: |-
When true (Windows only), the core Agent starts the dd-procmgr-service Windows service.
On Linux, the process manager daemon is started by systemd; this option is ignored.
comment: |-
Process manager (dd-procmgrd): on Windows the core agent starts dd-procmgr-service when enabled.
On Linux, dd-procmgrd is managed by systemd (datadog-agent-procmgr.service); this setting is ignored there.
tag_value_split_separator:
node_type: setting
type: object
default: {}
additionalProperties:
type: string
visibility: public
description: |-
Split tag values according to a given separator. Only applies to host tags,
and tags coming from container integrations. It does not apply to tags on dogstatsd metrics,
and tags collected by other integrations.
Example use-case:
With a raw collected tag "foo:1;2;3", using the following configuration:
tag_value_split_separator:
foo: ;
results in the raw tag being transformed into "foo:1", "foo:2", "foo:3" tags
example: |2-
<TAG_KEY>: <SEPARATOR>
tags:
- template_section:Common
checks_tag_cardinality:
node_type: setting
type: string
default: low
visibility: public
description: |-
Configure the level of granularity of tags to send for checks metrics and events. Choices are:
* low: add tags about low-cardinality objects (clusters, hosts, deployments, container images, ...)
* orchestrator: add tags about pod, (in Kubernetes), or task (in ECS or Mesos) -level of cardinality
* high: add tags about high-cardinality objects (individual containers, user IDs in requests, ...)
WARNING: sending container tags for checks metrics may create more metrics
(one per container instead of one per host). This may impact your custom metrics billing.
tags:
- template_section:Common
- full-agent-only:true
comment: |-
Set defaults for config keys that may be accessed but aren't relevant in serverless environments
to avoid "config key is unknown" and "unable to cast nil" warnings
dogstatsd_tag_cardinality:
node_type: setting
type: string
default: low
visibility: public
description: |-
Configure the level of granularity of tags to send for DogStatsD metrics and events. Choices are:
* low: add tags about low-cardinality objects (clusters, hosts, deployments, container images, ...)
* orchestrator: add tags about pod, (in Kubernetes), or task (in ECS or Mesos) -level of cardinality
* high: add tags about high-cardinality objects (individual containers, user IDs in requests, ...)
WARNING: sending container tags for dogstatsd metrics may create more metrics
(one per container instead of one per host). This may impact your custom metrics billing.
tags:
- template_section:Common
- full-agent-only:true
histogram_aggregates:
node_type: setting
type: array
default:
- max
- median
- avg
- count
items:
type: string
visibility: public
description: |-
Configure which aggregated value to compute.
Possible values are: min, max, median, avg, sum and count.
tags:
- template_section:Common
histogram_percentiles:
node_type: setting
type: array
default:
- '0.95'
items:
type: string
visibility: public
description: |-
Configure which percentiles are computed by the Agent. It must be a list of float between 0 and 1.
Warning: percentiles must be specified as yaml strings
tags:
- template_section:Common
histogram_copy_to_distribution:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
Copy histogram values to distributions for true global distributions (in beta)
Note: This increases the number of custom metrics created.
tags:
- template_section:Common
histogram_copy_to_distribution_prefix:
node_type: setting
type: string
default: ''
visibility: public
description: A prefix to add to distribution metrics created when histogram_copy_to_distributions
is true
example: '"<PREFIX>"'
tags:
- template_section:Common
aggregator_stop_timeout:
node_type: setting
type: integer
default: 2
visibility: public
description: |-
When stopping the agent, the Aggregator will try to flush out data ready for
aggregation (metrics, events, ...). Data are flushed to the Forwarder in order
to be sent to Datadog, therefore the Agent might take at most
'aggregator_stop_timeout'+'forwarder_stop_timeout' seconds to exit.
You can set the maximum amount of time, in seconds, allocated to the
Aggregator to do so. You can disable this feature by setting
'aggregator_stop_timeout' to 0.
tags:
- template_section:Common
aggregator_buffer_size:
node_type: setting
type: integer
default: 100
visibility: public
description: |-
The default buffer size for the aggregator use a sane value for most of the
use cases, however, it could be useful to manually set it in order to trade
RSS usage with better performances.
tags:
- template_section:Common
forwarder_timeout:
node_type: setting
type: integer
default: 20
visibility: public
description: Forwarder timeout in seconds
tags:
- template_section:Common
use_v3_api:
node_type: section
type: object
visibility: public
description: Controls the use of the v3 metrics intake.
tags:
- template_section:Common
properties:
series:
node_type: section
type: object
visibility: public
description: Controls the use of the v3 metrics intake for non-distribution
metrics (series).
tags:
- template_section:Common
properties:
enabled:
node_type: setting
type: string
default: datadog_only
visibility: public
description: |-
Global default for the non-distribution metrics intake version. Accepted values:
- true: v3 for every destination except Observability Pipelines Worker.
- datadog_only: v3 only when the destination URL is a Datadog endpoint.
- false: v2 everywhere.
endpoints:
node_type: setting
type: object
default: {}
additionalProperties:
type: string
visibility: public
description: |-
Per-URL override map for non-distribution metrics intake version. The URL
must match exactly what was configured under `dd_url` or `additional_endpoints`.
Accepted values:
- true: v3 for every destination except Observability Pipelines Worker.
- datadog_only: v3 only when the destination URL is a Datadog endpoint.
- false: v2 everywhere.
forwarder_retry_queue_payloads_max_size:
node_type: setting
type: integer
default: 15728640
visibility: public
description: |-
It defines the maximum size in bytes of all the payloads in the forwarder's retry queue.
The actual memory used is greater than the payloads size as there are extra fields like HTTP headers,
but no more than 2.5 times the payload size. The default is 15MB.
tags:
- template_section:Common
forwarder_num_workers:
node_type: setting
type: integer
default: 1
visibility: public
description: The number of workers used by the forwarder.
tags:
- template_section:Common
forwarder_stop_timeout:
node_type: setting
type: integer
default: 2
visibility: public
description: |-
When stopping the agent, the Forwarder will try to flush all new
transactions (not the ones in retry state). New transactions will be created
as the Aggregator flush it's internal data too, therefore the Agent might take
at most 'aggregator_stop_timeout'+'forwarder_stop_timeout' seconds to exit.
You can set the maximum amount of time, in seconds, allocated to the
Forwarder to send those transactions. You can disable this feature by setting
'forwarder_stop_timeout' to 0.
tags:
- template_section:Common
forwarder_http_protocol:
node_type: setting
type: string
default: auto
visibility: public
description: The transport type to use for sending logs. Possible values are "auto"
or "http1".
tags:
- template_section:Common
forwarder_max_concurrent_requests:
node_type: setting
type: integer
default: 10
visibility: public
description: |-
The maximum number of concurrent requests that each worker can have queued up
at any one time. If the connection is over HTTP/1 each request will be waiting
for the previous request to complete before sending the next one. With HTTP/2
each request can be sent before waiting for the response.
tags:
- template_section:Common
forwarder_storage_max_size_in_bytes:
node_type: setting
type: integer
default: 0
visibility: public
description: |-
When the retry queue of the forwarder is full, `forwarder_storage_max_size_in_bytes`
defines the amount of disk space the Agent can use to store transactions on the disk.
When `forwarder_storage_max_size_in_bytes` is `0`, the transactions are never stored on the disk.
example: '50000000'
tags:
- template_section:Common
comment: 0 means disabled. This is a BETA feature.
forwarder_storage_max_disk_ratio:
node_type: setting
type: number
default: 0.8
visibility: public
description: |-
`forwarder_storage_max_disk_ratio` defines the disk capacity limit for storing transactions.
`0.8` means the Agent can store transactions on disk until `forwarder_storage_max_size_in_bytes`
is reached or when the disk mount for `forwarder_storage_path` exceeds 80% of the disk capacity,
whichever is lower.
tags:
- golang_type:float64
- template_section:Common
comment: Do not store transactions on disk when the disk usage exceeds 80% of
the disk capacity. Use 80% as some applications do not behave well when the
disk space is very small.
forwarder_outdated_file_in_days:
node_type: setting
type: integer
default: 10
visibility: public
description: |-
This value specifies how many days the overflow transactions will remain valid before
being discarded. During the Agent restart, if a retry file contains transactions that were
created more than `forwarder_outdated_file_in_days` days ago, they are removed.
tags:
- template_section:Common
forwarder_high_prio_buffer_size:
node_type: setting
type: integer
default: 100
visibility: public
description: |-
Defines the size of the high prio buffer.
Increasing the buffer size can help if payload drops occur due to high prio buffer being full.
tags:
- template_section:Common
comment: Forwarder channels buffer size
forwarder_low_prio_buffer_size:
node_type: setting
type: integer
default: 100
visibility: public
description: Defines the size of the low prio buffer.
tags:
- template_section:Common
forwarder_requeue_buffer_size:
node_type: setting
type: integer
default: 100
visibility: public
description: Defines the size of the requeue prio buffer.
tags:
- template_section:Common
forwarder_backoff_base:
node_type: setting
type: integer
default: 2
visibility: public
description: |-
Defines the rate of exponential growth, and the first retry interval range.
Do not set a lower value than the default. You may increase it if you use a proxy that benefits from a
higher rate of exponential growth.
tags:
- template_section:Common
forwarder_backoff_max:
node_type: setting
type: integer
default: 64
visibility: public
description: |-
Defines the maximum number of seconds to wait for a retry.
Do not set a lower value than the default. You may increase it if you use a proxy that benefits from a
higher maximum backoff time.
tags:
- template_section:Common
cloud_provider_metadata:
node_type: setting
type: array
default:
- aws
- gcp
- azure
- alibaba
- oracle
- ibm
items:
type: string
visibility: public
description: |-
This option restricts which cloud provider endpoint will be used by the
agent to retrieve metadata. By default the agent will try # AWS, GCP, Azure
and alibaba providers. Some cloud provider are not enabled by default to not
trigger security alert when querying unknown IP (for example, when enabling
Tencent on AWS).
Setting an empty list will disable querying any cloud metadata endpoints
(falling back on system metadata). Disabling metadata for the cloud provider in which an Agent runs may result in
duplicated hosts in your Datadog account and missing Autodiscovery features
Possible values are:
"aws" AWS EC2, ECS/Fargate
"gcp" Google Cloud Provider
"azure" Azure
"alibaba" Alibaba
"tencent" Tencent
"oracle" Oracle Cloud
"ibm" IBM Cloud
tags:
- template_section:Common
collect_ec2_tags:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
Collect AWS EC2 custom tags as host tags.
Requires one of:
- `collect_ec2_tags_use_imds: true` and configuration of the
EC2 instance to allow tags in instance metadata; or
- configuration of the EC2 instance to have an IAM role with
the `EC2:DescribeTags` permission.
See docs for further details:
https://docs.datadoghq.com/integrations/faq/how-do-i-pull-my-ec2-tags-without-using-the-aws-integration/
tags:
- template_section:Common
- full-agent-only:true
collect_ec2_instance_info:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
Extend host tags with AWS EC2 instance information. The added tags are:
- region
- instance-type
- aws_account
- image
- availability-zone
This should only be enabled when the Datadog AWS integration cannot be enabled (see
https://docs.datadoghq.com/integrations/amazon_web_services/ for more information on the AWS integration).
Using the AWS integration is recommended as it offers more features and a better integration with the AWS environment.
tags:
- template_section:Common
- full-agent-only:true
exclude_ec2_tags:
node_type: setting
type: array
default: []
items:
type: string
visibility: public
description: |-
EC2 tags to exclude from being converted into host tags. This does not impact tags collected by the AWS Integration
(see https://docs.datadoghq.com/integrations/amazon_web_services/ for more information on the AWS integration).
This requires 'collect_ec2_tags' setting to be set to true.
tags:
- template_section:Common
- full-agent-only:true
collect_ec2_tags_use_imds:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
Use instance metadata service (IMDS) instead of EC2 API to collect AWS EC2 custom tags.
This requires 'collect_ec2_tags' setting to be set to true.
tags:
- template_section:Common
- full-agent-only:true
ec2_metadata_timeout:
node_type: setting
type: integer
default: 300
visibility: public
description: Timeout in milliseconds on calls to the AWS EC2 metadata endpoints.
tags:
- template_section:Common
- full-agent-only:true
comment: value in milliseconds
ec2_prefer_imdsv2:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
If this flag is true then the agent will request EC2 metadata using IMDS v2,
which offers additional security for accessing metadata. However, in some
situations (such as a containerized agent on a plain EC2 instance) it may
require additional configuration on the AWS side. See the AWS guidelines
for further details:
https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/configuring-instance-metadata-service.html#instance-metadata-transition-to-version-2
tags:
- template_section:Common
- full-agent-only:true
ec2_prioritize_instance_id_as_hostname:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
On EC2, prefer the instance ID as the Agent hostname even when the OS hostname does not match
the known generic EC2 prefixes. By default, the Agent uses the instance ID if the OS hostname
has a generic EC2 prefix to avoid merging multiple instances under one host. This is useful
when using custom images that share the same system hostname.
tags:
- template_section:Common
- full-agent-only:true
comment: used to bypass the hostname detection logic and force the EC2 instance
ID as a hostname.
collect_gce_tags:
node_type: setting
type: boolean
default: true
visibility: public
description: Collect Google Cloud Engine metadata as host tags
tags:
- template_section:Common
- full-agent-only:true
comment: GCE
exclude_gce_tags:
node_type: setting
type: array
default:
- bosh_settings
- cli-cert
- common-psm1
- configure-sh
- containerd-configure-sh
- disable-address-manager
- disable-legacy-endpoints
- enable-oslogin
- gce-container-declaration
- google-container-manifest
- ipsec-cert
- k8s-node-setup-psm1
- kube-env
- kubeconfig
- kubelet-config
- serial-port-logging-enable
- shutdown-script
- ssh-keys
- sshKeys
- ssl-cert
- startup-script
- user-data
- windows-keys
- windows-startup-script-ps1
items:
type: string
visibility: public
description: |-
Google Cloud Engine metadata attribute to exclude from being converted into
host tags -- only applicable when collect_gce_tags is true.
tags:
- template_section:Common
- full-agent-only:true
gce_send_project_id_tag:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
Send the project ID host tag with the `project_id:` tag key in addition to
the `project:` tag key.
tags:
- template_section:Common
- full-agent-only:true
gce_metadata_timeout:
node_type: setting
type: integer
default: 1000
visibility: public
description: Timeout in milliseconds on calls to the GCE metadata endpoints.
tags:
- template_section:Common
- full-agent-only:true
comment: value in milliseconds
collect_gpu_tags:
node_type: setting
type: boolean
default: true
visibility: public
description: Collect GPU related host tags
tags:
- template_section:Common
- full-agent-only:true
comment: GPU
gpu:
$ref: gpu.yaml
azure_metadata_timeout:
node_type: setting
type: integer
default: 300
visibility: public
description: Timeout in milliseconds on calls to the Azure metadata endpoints.
tags:
- template_section:Common
- full-agent-only:true
azure_hostname_style:
node_type: setting
type: string
default: os
visibility: public
description: |-
Changes how agent hostname is set on Azure virtual machines.
Possible values:
"os" - use the hostname reported by the operating system (default)
"name" - use the instance name
"name_and_resource_group" - use a combination of the instance name and resource group name
"full" - use a combination of the instance name, resource group name and subscription id
"vmid" - use the instance id
tags:
- template_section:Common
- full-agent-only:true
comment: Azure
azure_metadata_api_version:
node_type: setting
type: string
default: '2021-02-01'
visibility: public
description: |-
The API version to use when querying the Azure Instance Metadata Service (IMDS).
Change this if you need to use a different API version for compatibility reasons.
tags:
- template_section:Common
- full-agent-only:true
scrubber:
node_type: section
type: object
visibility: public
description: Configuration for scrubbing sensitive information from the Agent's
logs, configuration and flares.
tags:
- template_section:Common
properties:
additional_keys:
node_type: setting
type: array
default: []
items:
type: string
visibility: public
description: |-
By default, the Agent removes known sensitive keys from Agent and integrations YAML configs before
including them in the flare.
Use this parameter to define additional sensitive keys that the Agent should scrub from
the YAML files included in the flare.
example: |2-
- "sensitive_key_1"
- "sensitive_key_2"
no_proxy_nonexact_match:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
Enable more flexible no_proxy matching. See https://godoc.org/golang.org/x/net/http/httpproxy#Config
for more information on accepted matching criteria.
tags:
- template_section:Common
use_proxy_for_cloud_metadata:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
By default cloud provider IP's are added to the transport's `no_proxy` list.
Use this parameter to remove them from the `no_proxy` list.
tags:
- template_section:Common
inventories_configuration_enabled:
node_type: setting
type: boolean
default: true
visibility: public
description: |-
By default the Agent sends its own configuration to Datadog to be displayed in the `Agent Configuration` section of the host
detail panel. See https://docs.datadoghq.com/infrastructure/list/#agent-configuration for more information.
The Agent configuration is scrubbed of any sensitive information.
tags:
- template_section:Common
- full-agent-only:true
comment: controls the agent configurations
metadata_ip_resolution_from_hostname:
node_type: setting
type: boolean
default: false
visibility: public
description: |-
By default, the Agent uses the first interface in the list of network interfaces to determine the IP address of the host.
If you set this option to true, the Agent tries to resolve the host name to determine the host's IP address.
If this is unsuccessful, the Agent falls back to the default behavior.
This option is useful when the first interface is not the one you want to use to determine the host's IP address, or when
you define the hostname in the /etc/hosts configuration file.
tags:
- template_section:Common
- full-agent-only:true
comment: resolve the hostname to get the IP address
auto_exit:
node_type: section
type: object
visibility: public
description: 'Configuration for the automatic exit mechanism: the Agent stops
when some conditions are met.'
tags:
- template_section:Common
properties:
noprocess:
node_type: section
type: object
visibility: public
description: |-
Configure the `noprocess` automatic exit method.