Skip to content
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

Merged
merged 3 commits into from
Oct 6, 2016
Merged

Conversation

tsg
Copy link
Contributor

@tsg tsg commented Sep 23, 2016

A first draft, containing general infos about upgrading but also
specific information about the upgrade from 1.x to 5.x.

A first draft, containing general infos about upgrading but also
specific information about the upgrade from 1.x to 5.x.
Copy link
Member

@andrewkroh andrewkroh left a 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
Copy link
Member

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".

Copy link
Member

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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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
Copy link
Member

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?

Copy link
Contributor Author

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.

@dedemorton dedemorton mentioned this pull request Oct 4, 2016
50 tasks
@tsg
Copy link
Contributor Author

tsg commented Oct 5, 2016

Comments should be addressed on this one.

@ruflin ruflin merged commit 64c257f into elastic:master Oct 6, 2016
@tsg tsg added the needs_backport PR is waiting to be backported to other branches. label Oct 6, 2016
tsg added a commit to tsg/beats that referenced this pull request Oct 7, 2016
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
@tsg tsg removed the needs_backport PR is waiting to be backported to other branches. label Oct 7, 2016
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants