Skip to content

Commit 7ba1621

Browse files
Apply suggestions from code review
Co-authored-by: Adam Locke <[email protected]> Signed-off-by: esmerel <[email protected]>
1 parent 48dc0ee commit 7ba1621

File tree

1 file changed

+16
-16
lines changed

1 file changed

+16
-16
lines changed

installation/upgrade-notes.md

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Upgrade Notes
22

3-
The following article cover the relevant notes for users upgrading from previous
4-
Fluent Bit versions. These aim to cover compatibility changes that you must be aware of.
3+
The following article covers the relevant compatibility changes for users upgrading
4+
from previous Fluent Bit versions.
55

66
For more details about changes on each release, refer to the
7-
[Official Release Notes](https://fluentbit.io/announcements/).
7+
[Official Release Notes](https://fluentbit.io/announcements/).
88

99
Release notes will be prepared in advance of a Git tag for a release. An official
1010
release should provide both a tag and a release note together to allow users to
@@ -31,7 +31,7 @@ By default, the plugin follows a file from the end once the service starts, inst
3131
of reading from the beginning. Every file found at start is followed from it last
3232
position. New files discovered at runtime or rotated are read from the beginning.
3333

34-
To keep the old behavior, set the option `read_from_head` to true.
34+
To keep the old behavior, set the option `read_from_head` to `true`.
3535

3636
### Stackdriver Output Plugin
3737

@@ -48,21 +48,20 @@ If you have existing queries based on the resource's `project_id,` update your q
4848

4949
The migration from v1.4 to v1.5 is pretty straightforward.
5050

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

6362
## Fluent Bit v1.4
6463

65-
If you are migrating from Fluent Bit v1.3, there are no breaking changes, only new exciting features to enjoy :\)
64+
If you are migrating from Fluent Bit v1.3, there are no breaking changes.
6665

6766
## Fluent Bit v1.3
6867

@@ -75,7 +74,7 @@ If you are upgrading from an older version, review the following incremental cha
7574

7675
Fluent Bit v1.2 fixed many issues associated with JSON encoding and decoding.
7776

78-
For example, when parsing Docker logs it's no longer necessary** to use decoders. The
77+
For example, when parsing Docker logs, it's no longer necessary to use decoders. The
7978
new Docker parser looks like this:
8079

8180
```python
@@ -93,7 +92,7 @@ Fluent Bit made improvements to Kubernetes Filter handling of stringified `log`
9392
messages. If the `Merge_Log` option is enabled, it will try to handle the log content
9493
as a JSON map, if so, it will add the keys to the root map.
9594

96-
In addition, fixes and improvements where made to the `Merge_Log_Key` option. If a
95+
In addition, fixes and improvements were made to the `Merge_Log_Key` option. If a
9796
merge log succeed, all new keys will be packaged under the key specified by this
9897
option. A suggested configuration is as follows:
9998

@@ -152,7 +151,8 @@ The expected behavior is that Tag will be expanded to:
152151
kube.var.log.containers.apache.log
153152
```
154153

155-
but the change introduced in 1.0 series switched from absolute path to the base filename only:
154+
The change introduced in the 1.0 series switched from absolute path to the base
155+
filename only:
156156

157157
```text
158158
kube.apache.log
@@ -167,7 +167,7 @@ where it also helps to keep compatibility with Fluentd behavior.
167167
This behavior switch in Tail input plugin affects how Filter Kubernetes operates.
168168
When the filter is used it needs to perform local metadata lookup that comes from the
169169
file names when using Tail as a source. With the new `Kube_Tag_Prefix` option
170-
you can specify what's the prefix used in Tail input plugin, for the previous configuration
170+
you can specify the prefix used in the Tail input plugin. For the previous configuration
171171
example the new configuration will look like:
172172

173173
```python

0 commit comments

Comments
 (0)