Skip to content

Commit

Permalink
fluent: docs: elastic search plugin style updates
Browse files Browse the repository at this point in the history 
Signed-off-by: Lynette Miles <[email protected]>
  • Loading branch information
@esmerel
esmerel committed Oct 21, 2024
1 parent d708f7f commit ac4f645
Show file tree
Hide file tree
Showing 2 changed files with 136 additions and 98 deletions.
233 changes: 135 additions & 98 deletions pipeline/outputs/elasticsearch.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,28 +12,27 @@ operational Elasticsearch service running in your environment.

| Key | Description | Default |
| :--- | :--- | :--- |
| `Host` | IP address or hostname of the target Elasticsearch instance | 127.0.0.1 |
| `Host` | IP address or hostname of the target Elasticsearch instance | `127.0.0.1` |
| `Port` | TCP port of the target Elasticsearch instance | 9200 |
| `Path` | Elasticsearch accepts new data on HTTP query path `/_bulk`. It's also possible to serve Elasticsearch behind a reverse proxy on a sub-path. Define the path by adding a path prefix in the indexing HTTP POST URI. | Empty string |
| `compress` | Set payload compression mechanism. Option available is 'gzip' | |
| `Buffer_Size` | Specify the buffer size used to read the response from the Elasticsearch HTTP service. Useful for debugging purposes where it's required to read full responses. Response size grows depending of the number of records inserted. To set an _unlimited_ amount of memory set this value to **False**, otherwise the value must be according to the [Unit Size](../../administration/configuring-fluent-bit/unit-sizes.md) specification. | `512KB` |
| `Pipeline` | Newer versions of Elasticsearch allows to setup filters called pipelines. This option allows to define which pipeline the database should use. For performance reasons is strongly suggested to do parsing and filtering on Fluent Bit side, avoid pipelines. | |
| `AWS_Auth` | Enable AWS Sigv4 Authentication for Amazon OpenSearch Service | Off |
| `AWS_Region` | Specify the AWS region for Amazon OpenSearch Service | |
| `Path` | Elasticsearch accepts new data on HTTP query path `/_bulk`. You can also serve Elasticsearch behind a reverse proxy on a sub-path. Define the path by adding a path prefix in the indexing HTTP POST URI. | Empty string |
| `compress` | Set payload compression mechanism. Option available is `gzip`. | |
| `Buffer_Size` | Specify the buffer size used to read the response from the Elasticsearch HTTP service. Use for debugging purposes where required to read full responses. Response size grows depending of the number of records inserted. To use an unlimited amount of memory, set this value to `False`. Otherwise set the value according to the [Unit Size](../../administration/configuring-fluent-bit/unit-sizes.md). | `512KB` |
| `Pipeline` | Define which pipeline the database should use. For performance reasons, it's strongly suggested to do parsing and filtering on Fluent Bit side, and avoid pipelines. | |
| `AWS_Auth` | Enable AWS Sigv4 Authentication for Amazon OpenSearch Service. | `Off` |
| `AWS_Region` | Specify the AWS region for Amazon OpenSearch Service. | |
| `AWS_STS_Endpoint` | Specify the custom STS endpoint to be used with STS API for Amazon OpenSearch Service | |
| `AWS_Role_ARN` | AWS IAM Role to assume to put records to your Amazon cluster | |
| `AWS_External_ID` | External ID for the AWS IAM Role specified with `aws_role_arn` | |
| `AWS_Service_Name` | Service name to use in AWS Sigv4 signature. For integration with Amazon OpenSearch Serverless, set to `aoss`. See the [FAQ](opensearch.md#faq) section on Amazon OpenSearch Serverless for more information. | `es` |
| `AWS_Profile` | AWS profile name | default |
| `Cloud_ID` | If using Elastic's Elasticsearch Service you can specify the `cloud_id` of the cluster running. The string has the format `<deployment_name>:<base64_info>`. Once decoded, the `base64_info` string has the format `<deployment_region>$<elasticsearch_hostname>$<kibana_hostname>`.
| |
| `Cloud_ID` | If using Elastic's Elasticsearch Service you can specify the `cloud_id` of the cluster running. The string has the format `<deployment_name>:<base64_info>`. Once decoded, the `base64_info` string has the format `<deployment_region>$<elasticsearch_hostname>$<kibana_hostname>`. | |
| `Cloud_Auth` | Specify the credentials to use to connect to Elastic's Elasticsearch Service running on Elastic Cloud | |
| `HTTP_User` | Optional username credential for Elastic X-Pack access | |
| `HTTP_Passwd` | Password for user defined in `HTTP_User` | |
| `Index` | Index name | fluent-bit |
| `Index` | Index name | `fluent-bit` |
| `Type` | Type name | `_doc` |
| `Logstash_Format` | Enable Logstash format compatibility. This option takes a Boolean value: `True/False`, `On/Off` | `Off` |
| `Logstash_Prefix` | When Logstash\_Format is enabled, the Index name is composed using a prefix and the date, e.g: If `Logstash_Prefix` is equal to `mydata` your index will become `mydata-YYYY.MM.DD`. The last string appended belongs to the date when the data is being generated. | `logstash` |
| `Logstash_Prefix` | When `Logstash_Format` is enabled, the Index name is composed using a prefix and the date, e.g: If `Logstash_Prefix` is equal to `mydata` your index will become `mydata-YYYY.MM.DD`. The last string appended belongs to the date when the data is being generated. | `logstash` |
| `Logstash_Prefix_Key` | When included: the value of the key in the record will be evaluated as key reference and overrides `Logstash_Prefix` for index generation. If the key/value isn't found in the record then the `Logstash_Prefix` option will act as a fallback. The parameter is expected to be a [record accessor](../../administration/configuring-fluent-bit/classic-mode/record-accessor.md). | |
| `Logstash_Prefix_Separator` | Set a separator between `Logstash_Prefix` and date.| - |
| `Logstash_DateFormat` | Time format based on [strftime](http://man7.org/linux/man-pages/man3/strftime.3.html) to generate the second part of the Index name. | `%Y.%m.%d` |
Expand All @@ -45,17 +44,16 @@ operational Elasticsearch service running in your environment.
| `Generate_ID` | When enabled, generate `_id` for outgoing records. This prevents duplicate records when retrying ES. | `Off` |
| `Id_Key` | If set, `_id` will be the value of the key from incoming record and `Generate_ID` option is ignored. | |
| `Write_Operation` | `Write_operation` can be any of: `create`, `index`, `update`, `upsert`. | `create` |
| `Replace_Dots` | When enabled, replace field name dots with underscore, required by Elasticsearch 2.0-2.3. | `Off` |
| `Trace_Output` | Print all ElasticSearch API request payloads to `stdout` for diagnostics | `Off` |
| `Trace_Error` | If ElasticSearch returns an error, print the ElasticSearch API request and response for diagnostics | `Off` |
| `Current_Time_Index` | Use current time for index generation instead of message record | `Off` |
| `Suppress_Type_Name` | When enabled, mapping types is removed and `Type` option is
ignored. Elasticsearch 8.0.0 or higher [no longer supports mapping types](https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html), and is set to `On`. | `Off` |
| `Replace_Dots` | When enabled, replace field name dots with underscore. Required by Elasticsearch 2.0-2.3. | `Off` |
| `Trace_Output` | Print all ElasticSearch API request payloads to `stdout` for diagnostics. | `Off` |
| `Trace_Error` | If ElasticSearch returns an error, print the ElasticSearch API request and response for diagnostics. | `Off` |
| `Current_Time_Index` | Use current time for index generation instead of message record. | `Off` |
| `Suppress_Type_Name` | When enabled, mapping types is removed and `Type` option is ignored. Elasticsearch 8.0.0 or higher [no longer supports mapping types](https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html), and is set to `On`. | `Off` |
| `Workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `2` |

The parameters `index` and `type` can be confusing if you are new to Elastic, if you
have used a common relational database before, they can be compared to the `database`
and `table` concepts. Also see [the FAQ](elasticsearch.md#faq)
If you have used a common relational database, the parameters `index` and `type` can
be compared to the `database` and `table` concepts. Also see [the
FAQ](elasticsearch.md#faq)

### TLS / SSL

Expand All @@ -66,14 +64,18 @@ available and general configuration, refer to[TLS/SSL](../../administration/tran

The `write_operation` can be any of:

| Operation | Description |
| ------------- | ----------- |
| `create` | Adds new data. If the data already exists (based on its id), the op is skipped.|
| Operation | Description |
| ----------- | ----------- |
| `create` | Adds new data. If the data already exists (based on its id), the op is skipped.|
| `index` | New data is added while existing data (based on its id) is replaced (reindexed).|
| `update` | Updates existing data (based on its id). If no data is found, the op is skipped.|
| `upsert` | Known as merge or insert if the data does not exist, updates if the data exists (based on its id).|
| `update` | Updates existing data (based on its id). If no data is found, the op is skipped. |
| `upsert` | Merge or insert if the data doesn't exist, updates if the data exists (based on its id).|

**Please note, `Id_Key` or `Generate_ID` is required in update, and upsert scenario.**
{% hint style="info" %}

`Id_Key` or `Generate_ID` is required for `update` and `upsert`.

{% endhint %}

## Get started

Expand All @@ -82,7 +84,12 @@ command line or through the configuration file:

### Command Line

The **es** plugin can read the parameters from the command line in two ways, through the **-p** argument (property) or setting them directly through the service URI. The URI format is the following:
The **es** plugin can read the parameters from the command line in two ways:

- Through the `-p` argument (property)
- Setting them directly through the service URI.

The URI format is the following:

```text
es://host:port/index/type
Expand All @@ -104,7 +111,7 @@ fluent-bit -i cpu -t cpu -o es -p Host=192.168.2.3 -p Port=9200 \

### Configuration File

In your main configuration file append the following _Input_ & _Output_ sections. You can visualize this configuration [here](https://link.calyptia.com/qhq)
In your main configuration file append the following `Input` and `Output` sections. You can visualize this configuration [here](https://link.calyptia.com/qhq)

```python
[INPUT]
Expand All @@ -124,7 +131,9 @@ In your main configuration file append the following _Input_ & _Output_ sections

## About Elasticsearch field names

Some input plugins can generate messages where the field names contains dots, since Elasticsearch 2.0 this is not longer allowed, so the current **es** plugin replaces them with an underscore, e.g:
Some input plugins can generate messages where the field names contains dots. For
Elasticsearch 2.0, this isn't allowed. The current **es** plugin replaces
them with an underscore:

```text
{"cpu0.p_cpu"=>17.000000}
Expand All @@ -136,62 +145,21 @@ becomes
{"cpu0_p_cpu"=>17.000000}
```

## FAQ

### Elasticsearch rejects requests saying "the final mapping would have more than 1 type" <a id="faq-multiple-types"></a>

Elasticsearch 6.0 can't create multiple types in a single index. This
means that you can't set up your configuration like the following:.

```text
[OUTPUT]
Name es
Match foo.*
Index search
Type type1
[OUTPUT]
Name es
Match bar.*
Index search
Type type2
```

An error message like the following indicats you need to update your configuration to
use a single type on each index.

```text
Rejecting mapping update to [search] as the final mapping would have more than 1 type
```

For details, read [the official blog post on that issue](https://www.elastic.co/guide/en/elasticsearch/reference/6.7/removal-of-types.html).

### Elasticsearch rejects requests saying "Document mapping type name can't start with '\_'" <a id="faq-underscore"></a>
## Use Fluent Bit ElasticSearch plugin with other services

Fluent Bit v1.5 changed the default mapping type from `flb_type` to `_doc`, which matches the recommendation from Elasticsearch from version 6.2 forwards \([see commit with rationale](https://github.com/fluent/fluent-bit/commit/04ed3d8104ca8a2f491453777ae6e38e5377817e#diff-c9ae115d3acaceac5efb949edbb21196)\). This doesn't work in Elasticsearch versions 5.6 through 6.1 \([see Elasticsearch discussion and fix](https://discuss.elastic.co/t/cant-use-doc-as-type-despite-it-being-declared-the-preferred-method/113837/9)\). Ensure you set an explicit map \(such as `doc` or `flb_type`\) in the configuration, as seen on the last line:

```text
[OUTPUT]
Name es
Match *
Host vpc-test-domain-ke7thhzoo7jawsrhmm6mb7ite7y.us-west-2.es.amazonaws.com
Port 443
Index my_index
AWS_Auth On
AWS_Region us-west-2
tls On
Type doc
```
Connect to Amazon OpenSearch or Elastic Cloud with the ElasticSearch plugin.

### Fluent Bit + Amazon OpenSearch Service <a id="#aws-es"></a>
### Amazon OpenSearch Service

The Amazon OpenSearch Service adds an extra security layer where HTTP requests must be signed with AWS Sigv4. Fluent Bit v1.5 introduced full support for Amazon OpenSearch Service with IAM Authentication.
The Amazon OpenSearch Service adds an extra security layer where HTTP requests must
be signed with AWS Sigv4. Fluent Bit v1.5 introduced full support for Amazon
OpenSearch Service with IAM Authentication.

See [here](https://github.com/fluent/fluent-bit-docs/tree/43c4fe134611da471e706b0edb2f9acd7cdfdbc3/administration/aws-credentials.md) for details on how AWS credentials are fetched.
See [details](https://github.com/fluent/fluent-bit-docs/tree/43c4fe134611da471e706b0edb2f9acd7cdfdbc3/administration/aws-credentials.md) on how AWS credentials are fetched.

Example configuration:

```text
```text copy
[OUTPUT]
Name es
Match *
Expand All @@ -204,16 +172,20 @@ Example configuration:
tls On
```

Notice that the `Port` is set to `443`, `tls` is enabled, and `AWS_Region` is set.
Be aware that the `Port` is set to `443`, `tls` is enabled, and `AWS_Region` is set.

### Fluent Bit + Elastic Cloud
### Use Fluent Bit with Elastic Cloud

Fluent Bit supports connecting to [Elastic Cloud](https://www.elastic.co/guide/en/cloud/current/ec-getting-started.html) providing just the `cloud_id` and the `cloud_auth` settings.
`cloud_auth` uses the `elastic` user and password provided when the cluster was created, for details refer to the [Cloud ID usage page](https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html).
Fluent Bit supports connecting to
[Elastic Cloud](https://www.elastic.co/guide/en/cloud/current/ec-getting-started.html)
by providing the `cloud_id` and the `cloud_auth` settings. `cloud_auth` uses the
`elastic` user and password provided when the cluster was created. For details refer
to the
[Cloud ID usage page](https://www.elastic.co/guide/en/cloud/current/ec-cloud-id.html).

Example configuration:

```text
```text copy
[OUTPUT]
Name es
Include_Tag_Key true
Expand All @@ -225,35 +197,99 @@ Example configuration:
cloud_auth elastic:2vxxxxxxxxYV
```

### Validation Failed: 1: an id must be provided if version type or value are set
In Elastic Cloud version 8 and great, the type option must be removed by setting
`Suppress_Type_Name On`.

Without this you will see errors like:

```text
{"error":{"root_cause":[{"type":"illegal_argument_exception","reason":"Action/metadata line [1] contains an unknown parameter [_type]"}],"type":"illegal_argument_exception","reason":"Action/metadata line [1] contains an unknown parameter [_type]"},"status":400}
```

Since v1.8.2, Fluent Bit started using `create` method (instead of `index`) for data submission.
This makes Fluent Bit compatible with Datastream introduced in Elasticsearch 7.9.
## Troubleshooting

If you see `action_request_validation_exception` errors on your pipeline with Fluent Bit >= v1.8.2, you can fix it up by turning on `Generate_ID` as follows:
Use the following information to help resolve errors using the ElasticSearch plugin.

### Using multiple types in a single index

Elasticsearch 6.0 can't create multiple types in a single index. An error message
like the following indicates you need to update your configuration to use a single
type on each index.

```text
Rejecting mapping update to [products] as the final mapping would have more than 1 type:
```

This means that you can't set up your configuration like the following:.

```text
[OUTPUT]
Name es
Match *
Host 192.168.12.1
Generate_ID on
Name es
Match foo.*
Index search
Type type1
[OUTPUT]
Name es
Match bar.*
Index search
Type type2
```

### Action/metadata contains an unknown parameter type
For details, read [the official blog post on that issue](https://www.elastic.co/guide/en/elasticsearch/reference/6.7/removal-of-types.html).

### Mapping type names can't start with underscores (`_`)

Elastic Cloud is now on version 8 so the type option must be removed by setting `Suppress_Type_Name On` as indicated above.
Fluent Bit v1.5 changed the default mapping type from `flb_type` to `_doc`, matching
the recommendation from Elasticsearch for version 6.2 and greater
([see commit with
rationale](https://github.com/fluent/fluent-bit/commit/04ed3d8104ca8a2f491453777ae6e38e5377817e#diff-c9ae115d3acaceac5efb949edbb21196)).

Without this you will see errors like:
This doesn't work in Elasticsearch versions 5.6 through 6.1
([discussion and fix](https://discuss.elastic.co/t/cant-use-doc-as-type-despite-it-being-declared-the-preferred-method/113837/9)).

Ensure you set an explicit map such as `doc` or `flb_type` in the configuration,
as seen on the last line:

```text copy
[OUTPUT]
Name es
Match *
Host vpc-test-domain-ke7thhzoo7jawsrhmm6mb7ite7y.us-west-2.es.amazonaws.com
Port 443
Index my_index
AWS_Auth On
AWS_Region us-west-2
tls On
Type doc
```

### Validation failures

In Fluent Bit v1.8.2 and greater, Fluent Bit started using `create` method (instead
of `index`) for data submission. This makes Fluent Bit compatible with Datastream,
introduced in Elasticsearch 7.9. You might see errors like:

```text
{"error":{"root_cause":[{"type":"illegal_argument_exception","reason":"Action/metadata line [1] contains an unknown parameter [_type]"}],"type":"illegal_argument_exception","reason":"Action/metadata line [1] contains an unknown parameter [_type]"},"status":400}
Validation Failed: 1: an id must be provided if version type or value are set
```

If you see `action_request_validation_exception` errors on your pipeline with
Fluent Bit versions greater than v1.8.2, correct them by turning on `Generate_ID`
as follows:

```text copy
[OUTPUT]
Name es
Match *
Host 192.168.12.1
Generate_ID on
```

### Logstash_Prefix_Key
### `Logstash_Prefix_Key`

The following snippet demonstrates using the namespace name as extracted by the
`kubernetes` filter as logstash prefix:
`kubernetes` filter as `logstash` prefix:

```text
[OUTPUT]
Expand All @@ -265,4 +301,5 @@ The following snippet demonstrates using the namespace name as extracted by the
# ...
```

For records that do nor have the field `kubernetes.namespace_name`, the default prefix, `logstash` will be used.
For records that don't have the field `kubernetes.namespace_name`, the default prefix
`logstash` will be used.
1 change: 1 addition & 0 deletions vale-styles/FluentBit/Spelling-exceptions.txt
View file
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ Datadog
Datagen
datapoint
datapoints
Datastream
declaratively
deduplicate
Deployer
Expand Down

0 comments on commit ac4f645

Please sign in to comment.