- 필수 기능
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- 디지털 경험
- 소프트웨어 제공
- 보안
- 로그 관리
- 관리
- 인프라스트럭처
- ci
- containers
- csm
- ndm
- otel_guides
- overview
- slos
- synthetics
- tests
- 워크플로
Synthetic private locations come with a set of options you can configure to match your environment requirements. All options for the private location worker can be found by running the help
command:
docker run --rm datadog/synthetics-private-location-worker --help
synthetics-private-location.exe --help
Available parameters are listed below. These configuration options for private locations can be passed as parameters to your JSON configuration file or as arguments in the launch command, for example:
docker run --rm -v $PWD/<MY_WORKER_CONFIG_FILE_NAME>.json:/etc/datadog/synthetics-check-runner.json datadog/synthetics-private-location-worker:latest --logFormat=json
synthetics-private-location.exe --config=<PathToYourConfiguration> --logFormat=json
Arguments set in the launch command have precedence over the configuration file. However, these options are not stored and are consequently only relevant for a given launch.
site
datadoghq.com
site
is
.The following parameters can be used to customize DNS resolution on your API tests:
dnsUseHost
true
etc/resolv.conf
file), then DNS servers specified in the dnsServer
parameter.dnsServer
["8.8.8.8","1.1.1.1"]
--dnsServer="8.8.4.4" --dnsServer="8.8.8.8"
).On browser tests, the DNS resolution is done directly by the browser, which usually reads DNS servers from the host. Alternatively, you can configure it at the container level (for example, using the --dns
flag on Docker, or dnsConfig.nameservers
on Kubernetes).
proxyDatadog
none
--proxyDatadog=http://<YOUR_USER>:<YOUR_PWD>@<YOUR_IP>:<YOUR_PORT>
).Note: When setting up an HTTPS proxy, the HTTP CONNECT
request made to the proxy establishes the initial TCP connection between the private location and Datadog. As such, reverse proxies like HAProxy that direct an HTTP CONNECT
request to Datadog are not supported. Set up a forward proxy to open the connection to Datadog on behalf of the private location.
proxyTestRequests
none
pac+https://...
or pac+http://...
.proxyIgnoreSSLErrors
false
Note: The proxy
parameter is deprecated and should be replaced by proxyDatadog
.
concurrency
10
maxNumberMessagesToFetch
10
Note: Private Location containers output logs to stdout
and stderr
without saving them within the container.
--accessKey
none
--secretAccessKey
none
--datadogApiKey
none
--privateKey
none
--publicKey
none
--publicKey.pem
.--site
datadoghq.com
.--concurrency
10
--maxNumberMessagesToFetch
10
--proxyDatadog
none
--proxyDatadog=http://<YOUR_USER>:<YOUR_PWD>@<YOUR_IP>:<YOUR_PORT>
).--disableFipsCompliance
false
ddog-gov.com
.
By default, Private Locations reporting to ddog-gov.com
communicate to Datadog using FIPS-compliant encryption. The communication complies on the use of FIPS 140-2 validated Cryptographic Module - Certificate #4282. This option is required if you are using a Windows private location that reports to ddog-gov.com
.--dumpConfig
none
--enableStatusProbes
http://127.0.0.1:8080/liveness
and http://127.0.0.1:8080/readiness
.--statusProbesPort
8080
--config
/etc/datadog/synthetics-check-runner.json
--proxyTestRequests
none
pac+https://...
or pac+http://...
.--proxyIgnoreSSLErrors
false
--dnsUseHost
true
etc/resolv.conf
file), then DNS servers specified in the dnsServer
parameter.--dnsServer
["8.8.8.8","1.1.1.1"]
--dnsServer="8.8.4.4" --dnsServer="8.8.8.8"
).--variableOverride
VARIABLE=value
.
All variables imported this way are obfuscated.--environmentVariableOverride
docker run --env VARIABLE gcr.io/datadoghq/synthetics-private-location-worker --environmentVariableOverride VARIABLE
.
All variables imported this way are obfuscated.--allowedIPRanges
none
--enableDefaultBlockedIpRanges
or blockedIPRanges
(for example, "allowedIPRanges.4": "10.0.0.0/8"
). Note: allowedIPRanges
has precedence over blockedIPRanges
.--blockedIPRanges
none
--enableDefaultBlockedIpRanges
parameter to true
(for example, --blockedIPRanges.4="127.0.0.0/8" --blockedIPRanges.6="::1/128"
.)--enableDefaultBlockedIpRanges
false
--allowedIPRanges
parameter.--allowedDomainNames
none
--allowedDomainNames="*.example.com"
.--blockedDomainNames
none
--blockedDomainNames="example.org" --blockedDomainNames="*.com"
.--enableIPv6
false
--version
none
--logFormat
pretty
"compact"
, "pretty"
, "pretty-compact"
, and "json"
. Setting your log format to json
allows you to have these logs automatically parsed when collected by Datadog.--verbosity
3
1
(errors only) to 4
(debug logs and above). Setting the verbosity from the command line is done with -v
, -vv
, -vvv
, and -vvvv
arguments.Verbosity level | CLI argument | JSON config option |
---|---|---|
DEBUG | -vvvv | "verbosity": 4 |
INFO (default) | -vvv | "verbosity": 3 |
WARNING | -vv | "verbosity": 2 |
ERROR | -v | "verbosity": 1 |
--help
none
Command options can also be set using environment variables such as DATADOG_API_KEY="...", DATADOG_WORKER_CONCURRENCY="15", DATADOG_DNS_USE_HOST="true"
. For options that accept multiple arguments, use JSON string array notation (DATADOG_TESTS_DNS_SERVER='["8.8.8.8", "1.1.1.1"]'
)
DATADOG_ACCESS_KEY
, DATADOG_API_KEY
, DATADOG_PRIVATE_KEY
, DATADOG_PUBLIC_KEY_PEM
, DATADOG_SECRET_ACCESS_KEY
, DATADOG_SITE
, DATADOG_WORKER_CONCURRENCY
, DATADOG_WORKER_LOG_FORMAT
, DATADOG_WORKER_LOG_VERBOSITY
, DATADOG_WORKER_MAX_NUMBER_MESSAGES_TO_FETCH
, DATADOG_WORKER_PROXY
, DATADOG_TESTS_DNS_SERVER
, DATADOG_TESTS_DNS_USE_HOST
, DATADOG_TESTS_PROXY
, DATADOG_TESTS_PROXY_IGNORE_SSL_ERRORS
, DATADOG_ALLOWED_IP_RANGES_4
, DATADOG_ALLOWED_IP_RANGES_6
, DATADOG_BLOCKED_IP_RANGES_4
, DATADOG_BLOCKED_IP_RANGES_6
, DATADOG_ENABLE_DEFAULT_WINDOWS_FIREWALL_RULES
, DATADOG_ALLOWED_DOMAIN_NAMES
, DATADOG_BLOCKED_DOMAIN_NAMES
, DATADOG_WORKER_ENABLE_STATUS_PROBES
, DATADOG_WORKER_STATUS_PROBES_PORT
Additional helpful documentation, links, and articles: