[Doc] Rearrange breaking changes docs #6026
Conversation
| is typically located in `LS_HOME/config`, or `/etc/logstash` when installed via packages. Logstash will not be able | ||
| to start without this file, so please make sure to pass in `--path.settings` if you are starting Logstash manually | ||
| after installing it via a package (RPM, DEB). | ||
|
|
||
| **Release Packages:** When Logstash is installed via DEB, RPM packages, it uses `/usr/share/logstash` and `/var/lib/logstash` to install binaries and config files | ||
| * **Release Packages:** When Logstash is installed via DEB, RPM packages, it uses `/usr/share/logstash` and `/var/lib/logstash` to install binaries and config files |
There was a problem hiding this comment.
When we say, config files here, won't that be a bit confusing, if we already said that the configuration for RPM/DEB goes in /etc/logstash?
I'm thinking that this might be better worded as a "plugin metadata" path.
There was a problem hiding this comment.
I mean, it is the --path.data path we're talking about, right? Perhaps mention that.
| Also note that we have introduced new Getter/Setter APIs for accessing information in the Event object. | ||
| * **File Input:** SinceDB file is now saved in `path.data` location, not user's home. If you have manually specified `sincedb_path` | ||
| configuration, this change will not affect you. If you are moving from 2.x to 5.x, and would like to use the existing SinceDB file, it | ||
| has to be copied over to `path.data` manually to use the save state. |
There was a problem hiding this comment.
It's more than that. It's a subdirectory of path.data. It's "path.data/plugins/inputs/file"
See https://github.com/logstash-plugins/logstash-input-file/blob/master/lib/logstash/inputs/file.rb#L200
| importantly, the subfield for string multi-fields has changed from `.raw` to `.keyword` to match Elasticsearch's default | ||
| behavior. The impact of this change to various user groups is detailed below: | ||
|
|
||
| * New Logstash 5.0 and Elasticsearch 5.0 users - subfields use `.keyword` from the outset. In Kibana, you can use |
There was a problem hiding this comment.
This should be a sub-list of the previous item (right now, it's at the same level).
| event.set("[@metadata][foo]", "baz") | ||
| -------------------------------------------------- | ||
|
|
||
| Mutating collections after setting it in the Event has an undefined behaviour and is not allowed. |
There was a problem hiding this comment.
Subject/verb agreement is off. Do you meaning "Mutating a collection after setting it..."?
| [float] | ||
| === Event Object | ||
|
|
||
| Event is the main object which encapsulates data flow internally in Logstash and provides an API for the plugin |
There was a problem hiding this comment.
...than encapsulates...
| === Event Object | ||
|
|
||
| Event is the main object which encapsulates data flow internally in Logstash and provides an API for the plugin | ||
| developers to interact with the event's content. Typically, this API is used in plugins and in Ruby filter to |
There was a problem hiding this comment.
...in Ruby filters... (or in a Ruby filter)
|
LGTM (noted a few minor grammatical nits) |
Added new Event API doc to support breaking changes
suyograo
force-pushed
the
docs/event_api
branch
from
13c2f91
to
d9c0605
Compare
Added new Event API doc to support breaking changes
Added new Event API doc to support breaking changes
Added new Event API doc to support breaking changes