Skip to content

[SYNTH-19390] Update pl config #29113

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
May 5, 2025
Merged

[SYNTH-19390] Update pl config #29113

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1bb9478
update pl config
SKYWy May 2, 2025
e319399
improve wording
SKYWy May 5, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 23 additions & 8 deletions content/en/synthetics/platform/private_locations/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,9 +31,9 @@ synthetics-pl-worker.exe --help
{{% tab "Kubernetes" %}}

Refer to the example in the [Datadog Helm repository][1].

[1]: https://github.com/DataDog/helm-charts/tree/main/charts/synthetics-private-location

{{% /tab %}}
{{< /tabs >}}

Expand Down Expand Up @@ -128,6 +128,21 @@ Maximum number of tests executed in parallel.
**Default**: `10`<br>
Maximum number of tests fetched from Datadog.

`maxAPIDownloadBodySize`
: **Type**: Number <br>
**Default**: `52428800`<br>
Maximum HTTP body size for a download in bytes, default is 50 MB (50 * 1024 * 1024).

`maxAPIBodySizeIfProcessed`
: **Type**: Number <br>
**Default**: `5242880`<br>
Maximum HTTP body size for an assertion in bytes, default is 5 MB (5 * 1024 * 1024).

`apiRequestMaxTimeout`
: **Type**: Number <br>
**Default**: `60000`<br>
Maximum test execution duration for API tests, in milliseconds, default is one minute (60 * 1000).

**Note**: Private Location containers output logs to `stdout` and `stderr` without saving them within the container.

## All configuration options
Expand All @@ -140,14 +155,14 @@ Access key for Datadog API authentication.
`--secretAccessKey`
: **Type**: String <br>
**Default**: `none`<br>
Secret access key for Datadog API authentication.
Secret access key for Datadog API authentication.

`--datadogApiKey`
: **Type**: String <br>
**Default**: `none`<br>
Datadog API key to send browser tests artifacts (such as screenshots).
`--privateKey`
Datadog API key to send browser tests artifacts (such as screenshots).

`--privateKey`
: **Type**: Array <br>
**Default**: `none`<br>
Private key used to decrypt test configurations.
Expand Down Expand Up @@ -202,7 +217,7 @@ Overrides the port for the private location status probes.
**Default**: `/etc/datadog/synthetics-check-runner.json`</br>
**Windows**: `C:\ProgramData\Datadog-Synthetics\worker-config.json`</br>
Path to the JSON configuration file.

`--proxyTestRequests`
: **Type**: String <br>
**Default**: `none`<br>
Expand Down Expand Up @@ -237,7 +252,7 @@ All variables imported this way are obfuscated.
: **Type**: String <br>
Overrides variables used in tests running on the Private Location with environment variables. It requires the environment variables to be imported in the containerized environment.
With Docker, for example, `docker run --env VARIABLE gcr.io/datadoghq/synthetics-private-location-worker --environmentVariableOverride VARIABLE`.
All variables imported this way are obfuscated.
All variables imported this way are obfuscated.

`--allowedIPRanges`
: **Type**: Array of Strings <br>
Expand Down
Loading