From 1bb94788278c8aafa1369d0a109093460e15bb72 Mon Sep 17 00:00:00 2001 From: Katia SHANG Date: Fri, 2 May 2025 15:08:58 +0200 Subject: [PATCH 1/2] update pl config Signed-off-by: Katia SHANG --- .../private_locations/configuration.md | 31 ++++++++++++++----- 1 file changed, 23 insertions(+), 8 deletions(-) diff --git a/content/en/synthetics/platform/private_locations/configuration.md b/content/en/synthetics/platform/private_locations/configuration.md index 68ae358c11437..cc0ff1a86b4c2 100644 --- a/content/en/synthetics/platform/private_locations/configuration.md +++ b/content/en/synthetics/platform/private_locations/configuration.md @@ -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 >}} @@ -128,6 +128,21 @@ Maximum number of tests executed in parallel. **Default**: `10`
Maximum number of tests fetched from Datadog. +`maxAPIDownloadBodySize` +: **Type**: Number
+**Default**: `52428800`
+Maximum HTTP body size for a download in bytes, default is 50 MB (50 * 1024 * 1024). + +`maxAPIBodySizeIfProcessed` +: **Type**: Number
+**Default**: `5242880`
+Maximum HTTP body size for an assertion in bytes, default is 5 MB (5 * 1024 * 1024). + +`apiRequestMaxTimeout` +: **Type**: Number
+**Default**: `60000`
+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 @@ -140,14 +155,14 @@ Access key for Datadog API authentication. `--secretAccessKey` : **Type**: String
**Default**: `none`
-Secret access key for Datadog API authentication. +Secret access key for Datadog API authentication. `--datadogApiKey` : **Type**: String
**Default**: `none`
-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
**Default**: `none`
Private key used to decrypt test configurations. @@ -202,7 +217,7 @@ Overrides the port for the private location status probes. **Default**: `/etc/datadog/synthetics-check-runner.json`
**Windows**: `C:\ProgramData\Datadog-Synthetics\worker-config.json`
Path to the JSON configuration file. - + `--proxyTestRequests` : **Type**: String
**Default**: `none`
@@ -237,7 +252,7 @@ All variables imported this way are obfuscated. : **Type**: String
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
From e3193992c6660dbc508b92d78c5dfd9181753257 Mon Sep 17 00:00:00 2001 From: Katia SHANG Date: Mon, 5 May 2025 10:43:11 +0200 Subject: [PATCH 2/2] improve wording Signed-off-by: Katia SHANG --- .../synthetics/platform/private_locations/configuration.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/synthetics/platform/private_locations/configuration.md b/content/en/synthetics/platform/private_locations/configuration.md index cc0ff1a86b4c2..aeeda510f0ccc 100644 --- a/content/en/synthetics/platform/private_locations/configuration.md +++ b/content/en/synthetics/platform/private_locations/configuration.md @@ -131,17 +131,17 @@ Maximum number of tests fetched from Datadog. `maxAPIDownloadBodySize` : **Type**: Number
**Default**: `52428800`
-Maximum HTTP body size for a download in bytes, default is 50 MB (50 * 1024 * 1024). +Maximum HTTP body size for a download, in bytes. Default is 50 MB (50 * 1024 * 1024). `maxAPIBodySizeIfProcessed` : **Type**: Number
**Default**: `5242880`
-Maximum HTTP body size for an assertion in bytes, default is 5 MB (5 * 1024 * 1024). +Maximum HTTP body size for an assertion, in bytes. Default is 5 MB (5 * 1024 * 1024). `apiRequestMaxTimeout` : **Type**: Number
**Default**: `60000`
-Maximum test execution duration for API tests, in milliseconds, default is one minute (60 * 1000). +Maximum duration for API test execution, in milliseconds. Default is one minute (60 * 1000). **Note**: Private Location containers output logs to `stdout` and `stderr` without saving them within the container.