-
Notifications
You must be signed in to change notification settings - Fork 4.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Breaking changes and Upgrading docs #2631
Conversation
A first draft, containing general infos about upgrading but also specific information about the upgrade from 1.x to 5.x.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice write-up, very detailed.
These changes are made automatically by the migration script. | ||
|
||
In Filebeat, we refactored the configuration around when to close and when to | ||
start ignore files. Options like `ignore_older` and `force_close_older` were |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Either change to "start to ignore files" or "start ignoring files".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ignore_older is one of the few options that stayed the same. close_older
would be a good example.
|
||
==== Filebeat registry file location and format | ||
|
||
Filebeat stores which the read offset in a registry file that it persist to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think you can remove which
from this sentence.
==== Configuration file changes | ||
|
||
Beats 5.0 come with a more powerful and more robust <<config-file-format,file | ||
configuration format>>. While this necessarily cause a few breaking changes, we |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/cause/causes/ ?
|
||
Similarly, common settings available in all Beats are now top level. As part of | ||
this, the options under the `shipper` section are moved to the top level. For | ||
example, the `shipper.name` settings becomes `shipper`. This change is made |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
shipper.name
becomes name
(not shipper).
These changes are made automatically by the migration script. | ||
|
||
In Filebeat, we refactored the configuration around when to close and when to | ||
start ignore files. Options like `ignore_older` and `force_close_older` were |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ignore_older is one of the few options that stayed the same. close_older
would be a good example.
==== Filebeat registry file location and format | ||
|
||
Filebeat stores which the read offset in a registry file that it persist to | ||
disk. The format of this file has changed in version 5.0, but the Filebeat code |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
s/but the Filebeat code/but Filebeat/
the Elasticsearch mapping, which can result in visualization problems or | ||
incorect data. | ||
|
||
You can set the `output.elasticsearch.template.overwrite` option to `true` to |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should we add here an example with the -E option that this could be also done only once on startup without having to modify the config file?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good idea, I'll add it.
Comments should be addressed on this one. |
A first draft, containing general infos about upgrading but also specific information about the upgrade from 1.x to 5.x. * Addressed comments, mostly typos * Added example -E command for overwritting the template
A first draft, containing general infos about upgrading but also specific information about the upgrade from 1.x to 5.x. * Addressed comments, mostly typos * Added example -E command for overwritting the template
A first draft, containing general infos about upgrading but also
specific information about the upgrade from 1.x to 5.x.