Skip to content

Commit 862c575

Browse files
authored
outputs: elasticsearch: aws updates (fluent#341)
* add docs around v1.5 out_es change to ES type; ce - in v1.5, the default `type` was changed, which can cause problems. Highlighted this in the upgrade notes and added a 'FAQ' to the `out_es` page. - since v1.5 introduces aws auth support, added more text to highlight that `AWS\_Region` is required. If not, it dies at runtime. Seems like it could be inferred, but at least the docs reflect it a little better. - minor copyedits throughout. Signed-off-by: ted <[email protected]>
1 parent dc8a60f commit 862c575

File tree

5 files changed

+27
-9
lines changed

5 files changed

+27
-9
lines changed

concepts/buffering.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Performance and Data Safety
44

55
# Buffering
66

7-
When [Fluent Bit](https://fluentbit.io) process data, it uses the system memory \(heap\) as a primary and temporal place to store the record logs before they get delivered, on this private memory area the records are processed.
7+
When [Fluent Bit](https://fluentbit.io) processes data, it uses the system memory \(heap\) as a primary and temporal place to store the record logs before they get delivered, on this private memory area the records are processed.
88

99
Buffering refers to the ability to store the records somewhere, and while they are processed and delivered, still be able to store more. Buffering in memory is the fastest mechanism, but there are certain scenarios where the mechanism requires special strategies to deal with [backpressure](../administration/backpressure.md), data safety or reduce memory consumption by the service in constraint environments.
1010

concepts/data-pipeline/buffer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The `buffer` phase already contains the data in an immutable state, meaning, no
1111
![](../../.gitbook/assets/logging_pipeline_buffer%20%281%29.png)
1212

1313
{% hint style="info" %}
14-
Note that buffered data is not longer a raw text, instead it's in Fluent Bit internal binary representation.
14+
Note that buffered data is not raw text, it's in Fluent Bit's internal binary representation.
1515
{% endhint %}
1616

1717
Fluent Bit offers a buffering mechanism in the file system that acts as a _backup system_ to avoid data loss in case of system failures.

concepts/key-concepts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -103,7 +103,7 @@ Source events can have or not have a structure. A structure defines a set of _ke
103103
At a low level both are just an array of bytes, but the Structured message defines _keys_ and _values_, having a structure helps to implement faster operations on data modifications.
104104

105105
{% hint style="info" %}
106-
Fluent Bit **always** handle every Event message as a structured message. For performance reasons, we use a binary serialization data format called [MessagePack](https://msgpack.org/).
106+
Fluent Bit **always** handles every Event message as a structured message. For performance reasons, we use a binary serialization data format called [MessagePack](https://msgpack.org/).
107107

108108
Consider [MessagePack](https://msgpack.org/) as a binary version of JSON on steroids.
109109
{% endhint %}

installation/upgrade-notes.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,15 +8,16 @@ For more details about changes on each release please refer to the [Official Rel
88

99
The migration from v1.4 to v1.5 is pretty straightforward.
1010

11-
- If you enabled ```keepalive``` mode in your configuration, note that this configuration property has been renamed to ```net.keepalive```. Now all Network I/O is keepalive default enabled, to learn more about this and other associated configuration properties read the [Networking Administration](https://docs.fluentbit.io/manual/administration/networking#tcp-keepalive) section.
11+
- If you enabled `keepalive` mode in your configuration, note that this configuration property has been renamed to `net.keepalive`. Now all Network I/O keepalive is enabled by default, to learn more about this and other associated configuration properties read the [Networking Administration](https://docs.fluentbit.io/manual/administration/networking#tcp-keepalive) section.
12+
- If you use the Elasticsearch output plugin, note the default value of `type` [changed from `flb_type` to `_doc`](https://github.com/fluent/fluent-bit/commit/04ed3d8104ca8a2f491453777ae6e38e5377817e#diff-c9ae115d3acaceac5efb949edbb21196). Many versions of Elasticsearch will tolerate this, but ES v5.6 through v6.1 require a type *without* a leading underscore. See the [Elasticsearch output plugin documentation FAQ entry](https://docs.fluentbit.io/manual/pipeline/outputs/elasticsearch#faq-underscore) for more.
1213

1314
## Fluent Bit v1.4
1415

15-
If you are migrating from Fluent Bit v1.3, there are not breaking changes. Just new exciting features to enjoy :\)
16+
If you are migrating from Fluent Bit v1.3, there are no breaking changes. Just new exciting features to enjoy :\)
1617

1718
## Fluent Bit v1.3
1819

19-
If you are migrating from Fluent Bit v1.2 to v1.3, there are not breaking changes. If you are upgrading from an older version please review the incremental changes below.
20+
If you are migrating from Fluent Bit v1.2 to v1.3, there are no breaking changes. If you are upgrading from an older version please review the incremental changes below.
2021

2122
## Fluent Bit v1.2
2223

pipeline/outputs/elasticsearch.md

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -122,9 +122,26 @@ If you see an error message like below, you'll need to fix your configuration to
122122
123123
For details, please read [the official blog post on that issue](https://www.elastic.co/guide/en/elasticsearch/reference/6.7/removal-of-types.html).
124124

125-
### Fluent Bit + Amazon Elasticsearch Service
125+
### Elasticsearch rejects requests saying "Document mapping type name can't start with '\_'" <a id="faq-underscore"></a>
126126

127-
Amazon ElasticSearch Service adds an extra security layer where HTTP requests must be signed with AWS Sigv4. Fluent Bit v1.5 introduced full support for Amazon ElasticSearch Service with IAM Authentication.
127+
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:
128+
129+
```text
130+
[OUTPUT]
131+
Name es
132+
Match *
133+
Host vpc-test-domain-ke7thhzoo7jawsrhmm6mb7ite7y.us-west-2.es.amazonaws.com
134+
Port 443
135+
Index my_index
136+
AWS_Auth On
137+
AWS_Region us-west-2
138+
tls On
139+
Type doc
140+
```
141+
142+
### Fluent Bit + Amazon Elasticsearch Service <a id="#aws-es"></a>
143+
144+
The Amazon ElasticSearch Service adds an extra security layer where HTTP requests must be signed with AWS Sigv4. Fluent Bit v1.5 introduced full support for Amazon ElasticSearch Service with IAM Authentication.
128145

129146
Fluent Bit supports sourcing AWS credentials from any of the standard sources \(for example, an [Amazon EKS IAM Role for a Service Account](https://docs.aws.amazon.com/eks/latest/userguide/iam-roles-for-service-accounts.html)\).
130147

@@ -143,5 +160,5 @@ Example configuration:
143160
tls On
144161
```
145162

146-
Notice that the `Port` is set to `443`, and that `tls` is enabled.
163+
Notice that the `Port` is set to `443`, `tls` is enabled, and `AWS_Region` is set.
147164

0 commit comments

Comments
 (0)