From 34319f5e620e5aa713367e14186c5cce8c67e2d2 Mon Sep 17 00:00:00 2001 From: Zeeshan Alam Date: Tue, 25 Mar 2025 14:41:24 +0530 Subject: [PATCH 1/2] Documented path option for data prepper http sink Signed-off-by: Zeeshan Alam --- _data-prepper/pipelines/configuration/sources/http.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_data-prepper/pipelines/configuration/sources/http.md b/_data-prepper/pipelines/configuration/sources/http.md index 304a625822..ee460c4592 100644 --- a/_data-prepper/pipelines/configuration/sources/http.md +++ b/_data-prepper/pipelines/configuration/sources/http.md @@ -15,6 +15,7 @@ The `http` plugin accepts HTTP requests from clients. The following table descri Option | Required | Type | Description :--- | :--- | :--- | :--- port | No | Integer | The port that the source is running on. Default value is `2021`. Valid options are between `0` and `65535`. +path | No | String | The URI path for log ingestion and it should start with `/`. Path can contain `${pipelineName}` placeholder which will be replaced with pipeline name. Default value is `/log/ingest`. Path example `/${pipelineName}/logs` health_check_service | No | Boolean | Enables the health check service on the `/health` endpoint on the defined port. Default value is `false`. unauthenticated_health_check | No | Boolean | Determines whether or not authentication is required on the health check endpoint. OpenSearch Data Prepper ignores this option if no authentication is defined. Default value is `false`. request_timeout | No | Integer | The request timeout, in milliseconds. Default value is `10000`. From 1a759cb88f14aa641752ecd134f018b946a715e3 Mon Sep 17 00:00:00 2001 From: Zeeshan Alam Date: Fri, 11 Apr 2025 14:40:05 +0530 Subject: [PATCH 2/2] Update _data-prepper/pipelines/configuration/sources/http.md Co-authored-by: Naarcha-AWS <97990722+Naarcha-AWS@users.noreply.github.com> Signed-off-by: Zeeshan Alam --- _data-prepper/pipelines/configuration/sources/http.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_data-prepper/pipelines/configuration/sources/http.md b/_data-prepper/pipelines/configuration/sources/http.md index ee460c4592..deb035b220 100644 --- a/_data-prepper/pipelines/configuration/sources/http.md +++ b/_data-prepper/pipelines/configuration/sources/http.md @@ -15,7 +15,7 @@ The `http` plugin accepts HTTP requests from clients. The following table descri Option | Required | Type | Description :--- | :--- | :--- | :--- port | No | Integer | The port that the source is running on. Default value is `2021`. Valid options are between `0` and `65535`. -path | No | String | The URI path for log ingestion and it should start with `/`. Path can contain `${pipelineName}` placeholder which will be replaced with pipeline name. Default value is `/log/ingest`. Path example `/${pipelineName}/logs` +path | No | String | The URI path for log ingestion should start with a forward slash (/), for example, `/${pipelineName}/logs`. The `${pipelineName}` placeholder will be replaced with the pipeline name. The default value is `/log/ingest`. health_check_service | No | Boolean | Enables the health check service on the `/health` endpoint on the defined port. Default value is `false`. unauthenticated_health_check | No | Boolean | Determines whether or not authentication is required on the health check endpoint. OpenSearch Data Prepper ignores this option if no authentication is defined. Default value is `false`. request_timeout | No | Integer | The request timeout, in milliseconds. Default value is `10000`.