-
Notifications
You must be signed in to change notification settings - Fork 473
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' into 20230825-edit-document-level-permissions
- Loading branch information
Showing
26 changed files
with
1,424 additions
and
106 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1 @@ | ||
* @hdhalter @kolchfa-aws @Naarcha-AWS @vagimeli @AMoo-Miki @natebower @dlvenable @scrawfor99 | ||
* @hdhalter @kolchfa-aws @Naarcha-AWS @vagimeli @AMoo-Miki @natebower @dlvenable @scrawfor99 @epugh |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
15 changes: 15 additions & 0 deletions
15
_data-prepper/managing-data-prepper/extensions/extensions.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,15 @@ | ||
--- | ||
layout: default | ||
title: Extensions | ||
parent: Managing Data Prepper | ||
has_children: true | ||
nav_order: 18 | ||
--- | ||
|
||
# Extensions | ||
|
||
Data Prepper extensions provide Data Prepper functionality outside of core Data Prepper pipeline components. | ||
Many extensions provide configuration options that give Data Prepper administrators greater flexibility over Data Prepper's functionality. | ||
|
||
Extension configurations can be configured in the `data-prepper-config.yaml` file under the `extensions:` YAML block. | ||
|
67 changes: 67 additions & 0 deletions
67
_data-prepper/managing-data-prepper/extensions/geoip_service.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,67 @@ | ||
--- | ||
layout: default | ||
title: geoip_service | ||
nav_order: 5 | ||
parent: Extensions | ||
grand_parent: Managing Data Prepper | ||
--- | ||
|
||
# geoip_service | ||
|
||
The `geoip_service` extension configures all [`geoip`]({{site.url}}{{site.baseurl}}/data-prepper/pipelines/configuration/processors/geoip) processors in Data Prepper. | ||
|
||
## Usage | ||
|
||
You can configure the GeoIP service that Data Prepper uses for the `geoip` processor. | ||
By default, the GeoIP service comes with the [`maxmind`](#maxmind) option configured. | ||
|
||
The following example shows how to configure the `geoip_service` in the `data-prepper-config.yaml` file: | ||
|
||
``` | ||
extensions: | ||
geoip_service: | ||
maxmind: | ||
database_refresh_interval: PT1H | ||
cache_count: 16_384 | ||
``` | ||
|
||
## maxmind | ||
|
||
The GeoIP service supports the MaxMind [GeoIP and GeoLite](https://dev.maxmind.com/geoip) databases. | ||
By default, Data Prepper will use all three of the following [MaxMind GeoLite2](https://dev.maxmind.com/geoip/geolite2-free-geolocation-data) databases: | ||
|
||
* City | ||
* Country | ||
* ASN | ||
|
||
The service also downloads databases automatically to keep Data Prepper up to date with changes from MaxMind. | ||
|
||
You can use the following options to configure the `maxmind` extension. | ||
|
||
Option | Required | Type | Description | ||
:--- | :--- | :--- | :--- | ||
`databases` | No | [database](#database) | The database configuration. | ||
`database_refresh_interval` | No | Duration | How frequently to check for updates from MaxMind. This can be any duration in the range of 15 minutes to 30 days. Default is `PT7D`. | ||
`cache_count` | No | Integer | The maximum cache count by number of items in the cache, with a range of 100--100,000. Default is `4096`. | ||
`database_destination` | No | String | The name of the directory in which to store downloaded databases. Default is `{data-prepper.dir}/data/geoip`. | ||
`aws` | No | [aws](#aws) | Configures the AWS credentials for downloading the database from Amazon Simple Storage Service (Amazon S3). | ||
`insecure` | No | Boolean | When `true`, this options allows you to download database files over HTTP. Default is `false`. | ||
|
||
## database | ||
|
||
Option | Required | Type | Description | ||
:--- | :--- | :--- | :--- | ||
`city` | No | String | The URL of the city in which the database resides. Can be an HTTP URL for a manifest file, an MMDB file, or an S3 URL. | ||
`country` | No | String | The URL of the country in which the database resides. Can be an HTTP URL for a manifest file, an MMDB file, or an S3 URL. | ||
`asn` | No | String | The URL of the Autonomous System Number (ASN) of where the database resides. Can be an HTTP URL for a manifest file, an MMDB file, or an S3 URL. | ||
`enterprise` | No | String | The URL of the enterprise in which the database resides. Can be an HTTP URL for a manifest file, an MMDB file, or an S3 URL. | ||
|
||
|
||
## aws | ||
|
||
Option | Required | Type | Description | ||
:--- | :--- | :--- | :--- | ||
`region` | No | String | The AWS Region to use for the credentials. Default is the [standard SDK behavior for determining the Region](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/region-selection.html). | ||
`sts_role_arn` | No | String | The AWS Security Token Service (AWS STS) role to assume for requests to Amazon S3. Default is `null`, which will use the [standard SDK behavior for credentials](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/credentials.html). | ||
`aws_sts_header_overrides` | No | Map | A map of header overrides that the AWS Identity and Access Management (IAM) role assumes when downloading from Amazon S3. | ||
`sts_external_id` | No | String | An STS external ID used when Data Prepper assumes the STS role. For more information, see the `ExternalID` documentation in the [STS AssumeRole](https://docs.aws.amazon.com/STS/latest/APIReference/API_AssumeRole.html) API reference. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
_data-prepper/pipelines/configuration/processors/decompress.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,49 @@ | ||
--- | ||
layout: default | ||
title: decompress | ||
parent: Processors | ||
grand_parent: Pipelines | ||
nav_order: 40 | ||
--- | ||
|
||
# decompress | ||
|
||
The `decompress` processor decompresses any Base64-encoded compressed fields inside of an event. | ||
|
||
## Configuration | ||
|
||
Option | Required | Type | Description | ||
:--- | :--- | :--- | :--- | ||
`keys` | Yes | List<String> | The fields in the event that will be decompressed. | ||
`type` | Yes | Enum | The type of decompression to use for the `keys` in the event. Only `gzip` is supported. | ||
`decompress_when` | No | String| A [Data Prepper conditional expression](https://opensearch.org/docs/latest/data-prepper/pipelines/expression-syntax/) that determines when the `decompress` processor will run on certain events. | ||
`tags_on_failure` | No | List<String> | A list of strings with which to tag events when the processor fails to decompress the `keys` inside an event. Defaults to `_decompression_failure`. | ||
|
||
## Usage | ||
|
||
The following example shows the `decompress` processor used in `pipelines.yaml`: | ||
|
||
```yaml | ||
processor: | ||
- decompress: | ||
decompress_when: '/some_key == null' | ||
keys: [ "base_64_gzip_key" ] | ||
type: gzip | ||
``` | ||
## Metrics | ||
The following table describes common [abstract processor](https://github.com/opensearch-project/data-prepper/blob/main/data-prepper-api/src/main/java/org/opensearch/dataprepper/model/processor/AbstractProcessor.java) metrics. | ||
| Metric name | Type | Description | | ||
| ------------- | ---- | -----------| | ||
| `recordsIn` | Counter | The ingress of records to a pipeline component. | | ||
| `recordsOut` | Counter | The egress of records from a pipeline component. | | ||
| `timeElapsed` | Timer | The time elapsed during execution of a pipeline component. | | ||
|
||
### Counter | ||
|
||
The `decompress` processor accounts for the following metrics: | ||
|
||
* `processingErrors`: The number of processing errors that have occurred in the `decompress` processor. | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.