diff --git a/_data-prepper/configuration/sinks/file.md b/_data-prepper/configuration/sinks/file.md index 1fe9c70b..709010df 100644 --- a/_data-prepper/configuration/sinks/file.md +++ b/_data-prepper/configuration/sinks/file.md @@ -2,6 +2,7 @@ layout: default title: file sink parent: Sinks +grand_parent: Configuring Data Prepper nav_order: 45 --- @@ -15,10 +16,10 @@ Option | Required | Type | Description :--- | :--- | :--- | :--- path | Yes | String | Path for the output file (e.g. `logs/my-transformed-log.log`). -## Configuration + \ No newline at end of file diff --git a/_data-prepper/configuration/sinks/opensearch.md b/_data-prepper/configuration/sinks/opensearch.md index 4686a6fa..0887bda9 100644 --- a/_data-prepper/configuration/sinks/opensearch.md +++ b/_data-prepper/configuration/sinks/opensearch.md @@ -2,6 +2,7 @@ layout: default title: OpenSearch sink parent: Sinks +grand_parent: Configuring Data Prepper nav_order: 45 --- @@ -34,10 +35,10 @@ ism_policy_file | No | String | The absolute file path for an ISM (Index State M number_of_shards | No | Integer | The number of primary shards that an index should have on the destination OpenSearch server. This parameter is effective only when `template_file` is either explicitly provided in Sink configuration or built-in. If this parameter is set, it would override the value in index template file. For more information, see [Create index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/). number_of_replicas | No | Integer | The number of replica shards each primary shard should have on the destination OpenSearch server. For example, if you have 4 primary shards and set number_of_replicas to 3, the index has 12 replica shards. This parameter is effective only when `template_file` is either explicitly provided in Sink configuration or built-in. If this parameter is set, it would override the value in index template file. For more information, see [Create index]({{site.url}}{{site.baseurl}}/api-reference/index-apis/create-index/). -## Configuration + \ No newline at end of file diff --git a/_data-prepper/configuration/sinks/pipeline.md b/_data-prepper/configuration/sinks/pipeline.md index 2ea77e0a..bd17ae5e 100644 --- a/_data-prepper/configuration/sinks/pipeline.md +++ b/_data-prepper/configuration/sinks/pipeline.md @@ -2,6 +2,7 @@ layout: default title: Pipeline sink parent: Sinks +grand_parent: Configuring Data Prepper nav_order: 45 --- @@ -15,10 +16,10 @@ Option | Required | Type | Description :--- | :--- | :--- | :--- name | Yes | String | Name of the pipeline to write to. -## Configuration + \ No newline at end of file diff --git a/_data-prepper/configuration/sinks/stdout.md b/_data-prepper/configuration/sinks/stdout.md index f58e5299..93fbc290 100644 --- a/_data-prepper/configuration/sinks/stdout.md +++ b/_data-prepper/configuration/sinks/stdout.md @@ -2,6 +2,7 @@ layout: default title: stdout sink parent: Sinks +grand_parent: Configuring Data Prepper nav_order: 45 --- @@ -11,10 +12,10 @@ nav_order: 45 Sink for console output. Can be useful for testing. No options. -## Configuration + \ No newline at end of file diff --git a/_data-prepper/configuration/sources/http-source.md b/_data-prepper/configuration/sources/http-source.md index 5c16234c..46fcc64c 100644 --- a/_data-prepper/configuration/sources/http-source.md +++ b/_data-prepper/configuration/sources/http-source.md @@ -2,13 +2,11 @@ layout: default title: http_source parent: Sources +grand_parent: Configuring Data Prepper nav_order: 5 --- - -# Overview - -## http_source +# http_source This is a source plugin that supports HTTP protocol. Currently ONLY support Json UTF-8 codec for incoming request, e.g. `[{"key1": "value1"}, {"key2": "value2"}]`. @@ -31,10 +29,10 @@ acm_private_key_password | No | String | ACM private key password that decrypts acm_certificate_timeout_millis | No | Integer | Timeout in milliseconds for ACM to get certificates. Default is 120000. aws_region | Conditionally | String | AWS region to use ACM or S3. Required if `use_acm_certificate_for_ssl` is set to true or `ssl_certificate_file` and `ssl_key_file` is AWS S3 path. -## Configuration + \ No newline at end of file diff --git a/_data-prepper/configuration/sources/otel-metrics-source.md b/_data-prepper/configuration/sources/otel-metrics-source.md index e29d1b8e..3c9ade69 100644 --- a/_data-prepper/configuration/sources/otel-metrics-source.md +++ b/_data-prepper/configuration/sources/otel-metrics-source.md @@ -2,13 +2,11 @@ layout: default title: otel_metrics_source parent: Sources +grand_parent: Configuring Data Prepper nav_order: 10 --- - -# Overview - -## otel_metrics_source +# otel_metrics_source Source for the OpenTelemetry Collector for collecting metric data. @@ -29,10 +27,10 @@ acmCertificateArn | Conditionally | String | Represents the ACM certificate ARN. awsRegion | Conditionally | String | Represents the AWS Region to use ACM or S3. Required if `useAcmCertForSSL` is set to `true` or `sslKeyCertChainFile` and `sslKeyFile` are AWS S3 paths. authentication | No | Object | An authentication configuration. By default, an unauthenticated server is created for the pipeline. This uses pluggable authentication for HTTPS. To use basic authentication, define the `http_basic` plugin with a `username` and `password`. To provide customer authentication, use or create a plugin that implements [GrpcAuthenticationProvider](https://github.com/opensearch-project/data-prepper/blob/main/data-prepper-plugins/armeria-common/src/main/java/com/amazon/dataprepper/armeria/authentication/GrpcAuthenticationProvider.java). -## Configuration + \ No newline at end of file diff --git a/_data-prepper/configuration/sources/otel-trace.md b/_data-prepper/configuration/sources/otel-trace.md index 61a37f96..07772579 100644 --- a/_data-prepper/configuration/sources/otel-trace.md +++ b/_data-prepper/configuration/sources/otel-trace.md @@ -2,6 +2,7 @@ layout: default title: otel_trace_source source parent: Sources +grand_parent: Configuring Data Prepper nav_order: 15 --- @@ -30,10 +31,10 @@ acmCertificateArn | Conditionally | String | Represents the ACM certificate ARN. awsRegion | Conditionally | String | Represents the AWS region to use ACM or S3. Required if `useAcmCertForSSL` is set to `true` or `sslKeyCertChainFile` and `sslKeyFile` are AWS S3 paths. authentication | No | Object | An authentication configuration. By default, an unauthenticated server is created for the pipeline. This parameter uses pluggable authentication for HTTPS. To use basic authentication, define the `http_basic` plugin with a `username` and `password`. To provide customer authentication, use or create a plugin that implements [GrpcAuthenticationProvider](https://github.com/opensearch-project/data-prepper/blob/main/data-prepper-plugins/armeria-common/src/main/java/com/amazon/dataprepper/armeria/authentication/GrpcAuthenticationProvider.java). -## Configuration + \ No newline at end of file diff --git a/_data-prepper/configuration/sources/s3.md b/_data-prepper/configuration/sources/s3.md index 5bdb958f..50bf3ab5 100644 --- a/_data-prepper/configuration/sources/s3.md +++ b/_data-prepper/configuration/sources/s3.md @@ -2,6 +2,7 @@ layout: default title: s3 parent: Sources +grand_parent: Configuring Data Prepper nav_order: 20 --- diff --git a/_data-prepper/configuration/sources/sources.md b/_data-prepper/configuration/sources/sources.md index 1553927c..12de7980 100644 --- a/_data-prepper/configuration/sources/sources.md +++ b/_data-prepper/configuration/sources/sources.md @@ -8,4 +8,4 @@ nav_order: 42 # Sources -Sources define where your data comes from. +Sources define where your data comes from within a Data Prepper pipeline.