Combined 5.0.0 release notes #2813

monicasarbu · 2016-10-20T13:24:39Z

This PR contains the first draft of the combined 5.0.0 release notes that includes the changes done starting with 5.0.0-alpha1 until 5.0.0-GA.

Here the result of this PR:

tsg · 2016-10-20T14:49:17Z

libbeat/docs/release-notes/5.0.0.asciidoc

+[[release-notes-5.0.0]]
+=== 5.0.0 Combined Release Notes
+
+The list below covers changes between 5.0.0-alpha1 to 5.0.0-GA.


I think we should say something like "between 1.3.1 and 5.0.0" or between "1.x and 5.0.0"

tsg · 2016-10-20T14:50:39Z

libbeat/docs/release-notes/5.0.0.asciidoc

+*Affecting all Beats*
+
+- Run function to start a Beat now returns an error instead of directly exiting. {pull}771[771]
+- The method signature of `HandleFlags()` was changed to allow returning an error {pull}1249[1249]


I'd leave these two (which are affecting only Beats writers) out, since a Beats user wouldn't know how this change affects them.

tsg · 2016-10-20T14:51:37Z

libbeat/docs/release-notes/5.0.0.asciidoc

+- All configuration settings under `shipper:` are moved to be top level configuration settings. I.e.
+  `shipper.name:` becomes `name:` in the configuration file. {pull}1570[1570]
+- The `topology_expire` option of the Elasticserach output was removed. {pull}1907[1907]
+- Rename the `filters` section to `processors`. {pull}1944[1944]


This one we don't need, because "filters" was never released.

tsg · 2016-10-20T14:52:04Z

libbeat/docs/release-notes/5.0.0.asciidoc

+  `shipper.name:` becomes `name:` in the configuration file. {pull}1570[1570]
+- The `topology_expire` option of the Elasticserach output was removed. {pull}1907[1907]
+- Rename the `filters` section to `processors`. {pull}1944[1944]
+- Introduce the condition with `when` in the processor configuration. {pull}1949[1949]


We don't need this one since the processors are new in 5.0

Generic filtering is part of Beats starting with 1.1.0: #1120

tsg · 2016-10-20T14:52:44Z

libbeat/docs/release-notes/5.0.0.asciidoc

+- The Redis output `index` setting is renamed to `key`. `index` still works but it's deprecated. {pull}2077[2077]
+- The undocumented file output `index` setting was removed. Use `filename` instead. {pull}2077[2077]
+- Change Elasticsearch output index configuration to be based on format strings. If index has been configured, no date will be appended anymore to the index name. {pull}2119[2119]
+- Replace `output.kafka.use_type` by `output.kafka.topic` accepting a format string. {pull}2188[2188]


We don't need this one since Kafka is new in 5.0

tsg · 2016-10-20T14:55:04Z

libbeat/docs/release-notes/5.0.0.asciidoc

+  rather than `.filebeat` in the current working directory. This affects installations for zip/tar.gz/source,
+  the location for DEB and RPM packages stays the same. {pull}1373[1373]
+- The state for files which fall under ignore_older is not stored anymore. This has the consequence, that if a file which fell under ignore_older is updated, the whole file will be crawled.
+- Stop following symlink. Symlinks are now ignored: {pull}1686[1686]


We changed our mind on this one. Symlinks are just disabled by default, but can be enabled from config.

dedemorton · 2016-10-20T16:08:41Z

I don't think users will know what we mean by "combined release notes" when they look at the TOC.

It would be better just to have an entry in the nav for Beats version 5.0.0 and provide the combined release notes there (all the release notes for the pre-releases consolidated and with no mention of pre-release versions). I would also suggest removing all the alpha/beta relnotes plus the relnotes for older releases. I'm not sure if that's possible since we've automated some of the work, but I think it would make more sense for 5.0 users to only see the GA-level release notes (consolidated).

dedemorton · 2016-10-20T16:10:31Z

libbeat/docs/release-notes/5.0.0.asciidoc

+[[release-notes-5.0.0]]
+=== 5.0.0 Combined Release Notes
+
+The list below covers changes between 1.3.1 to 5.0.0-GA.


If users want the list of changes for 1.3. I don't think these relnotes belong in the 5.0 docs.

Would be better to say 5.0.0-alpha1 to 5.0.0-GA?

I wrote 1.x to 5.0.0 releases.

dedemorton · 2016-10-20T16:22:17Z

libbeat/docs/release.asciidoc

@@ -30,3 +30,12 @@ This section summarizes the changes in each release.
 --

 include::../../CHANGELOG.asciidoc[]
+
+== Combined release notes


So to clarify my earlier comment, I think we need to have only the 5.0 release notes in this document. So the nav would look like:

Release Notes Beats version 5.0.0

Then when 5.0.1 comes out, we'll add another section. And if people want to see a more granular description of the changes, they can look at the changelog.

Maybe we keep to the automated format when we create pre-release software, but then we curate the list and create combined release notes at GA. Does that make sense?

tsg · 2016-10-20T21:18:58Z

@dedemorton The release notes docs simply include the CHANGELOG.asciidoc. That's why we don't have too much flexibility, and we can't remove releases from the docs but keep them in the CHANGELOG file.

I agree the combined notes should be named simply 5.0.0 and be the place where we send most users. But I'm not sure we can remove the pre-releases from there.

tsg · 2016-10-21T11:21:25Z

libbeat/docs/release-notes/5.0.0.asciidoc

+- Fixed the run script to allow the overriding of the configuration file. {issue}2171[2171]
+- Fix logstash output crash if no hosts are configured. {issue}2325[2325]
+- Fix array value support in `-E` CLI flag. {pull}2521[2521]
+- Fix merging array values if `-c` CLI flag is used multiple times. {pull}2521[2521]


These two features (-E and -c flags) were added in 5.0, so I think we can remove them from here.

tsg · 2016-10-21T11:22:11Z

libbeat/docs/release-notes/5.0.0.asciidoc

+- Fix merging array values if `-c` CLI flag is used multiple times. {pull}2521[2521]
+- Fix beats failing to start due to invalid duplicate key error in configuration file. {pull}2521[2521]
+- Fix panic on non writable logging directory. {pull}2571[2571]
+- Make sure Beats sent always float values when they are defined as float by sending 5.00000 instead of 5. {pull}2627[2627]


Not sure if this one is really a bug. Fits more into Added, to me.

monicasarbu · 2016-10-21T12:03:21Z

@dedemorton I suggest to keep things simple for this release, and add only a link to the combined release notes on top of all the release notes. Please see the screenshot from the description of the pull request.

tsg · 2016-10-24T08:36:55Z

libbeat/docs/release-notes/5.0.0.asciidoc

+- Update to Go 1.7. {pull}2306[2306]
+- Add option to Elasticsearch output to pass http parameters in index operations {issue}805[805]
+- Improve Logstash and Elasticsearch backoff behavior. {pull}927[927]
+- Add experimental Kafka output. {pull}942[942] {pull}2188[2188] {pull}2190[2190] {pull}2284[2284]


@urso Is the Kafka output experimental at this point? We don't seem to mark it as such in the docs. I'd go with fully supported.

urso confirmed on chat that we can take down "experimental".

tsg · 2016-10-24T08:46:10Z

libbeat/docs/release-notes/5.0.0.asciidoc

+- Use the new `scaled_float` Elasticsearch type for the percentage values. {pull}2156[2156]
+- Improve mapping by converting `half_float` to `scaled_float` and integers to long. {pull}2430[2430]
+- Add experimental `cgroup` metrics to the system/process MetricSet. {pull}2184[2184]
+- Add experimental `haproxy` module. {pull}2384[2384]


Add "happroxy" to the list above and remove this line? Otherwise its a bit random that haproxy gets its own line.

@tsg I used a different line for haproxy as it's experimental for now.

* Add 5.0.0 combined release notes * Remove experimental from Kafka (cherry picked from commit 8a69e53)

* Add 5.0.0 combined release notes * Remove experimental from Kafka

monicasarbu added docs review labels Oct 20, 2016

tsg reviewed Oct 20, 2016

View reviewed changes

dedemorton reviewed Oct 20, 2016

View reviewed changes

monicasarbu force-pushed the combined_release_notes_5.0 branch from ed609e6 to 2cd7ff8 Compare October 21, 2016 11:18

tsg reviewed Oct 21, 2016

View reviewed changes

monicasarbu force-pushed the combined_release_notes_5.0 branch from 66fedfc to 679e7a5 Compare October 21, 2016 12:00

Add 5.0.0 combined release notes

4a08c98

monicasarbu force-pushed the combined_release_notes_5.0 branch from 679e7a5 to 4a08c98 Compare October 24, 2016 08:29

tsg reviewed Oct 24, 2016

View reviewed changes

Remove experimental from Kafka

fecea5f

tsg reviewed Oct 24, 2016

View reviewed changes

tsg merged commit 8a69e53 into elastic:5.0 Oct 24, 2016

tsg added the needs_backport PR is waiting to be backported to other branches. label Oct 27, 2016

monicasarbu added a commit to monicasarbu/beats that referenced this pull request Oct 27, 2016

Combined 5.0.0 release notes (elastic#2813)

0ab629c

* Add 5.0.0 combined release notes * Remove experimental from Kafka (cherry picked from commit 8a69e53)

monicasarbu mentioned this pull request Oct 27, 2016

Backport: Combined 5.0.0 release notes (#2813) #2874

Merged

monicasarbu removed the needs_backport PR is waiting to be backported to other branches. label Oct 27, 2016

tsg pushed a commit that referenced this pull request Oct 28, 2016

Combined 5.0.0 release notes (#2813) (#2874)

47e4a48

* Add 5.0.0 combined release notes * Remove experimental from Kafka (cherry picked from commit 8a69e53)

leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023

Combined 5.0.0 release notes (elastic#2813)

d096d96

* Add 5.0.0 combined release notes * Remove experimental from Kafka

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Combined 5.0.0 release notes #2813

Combined 5.0.0 release notes #2813

monicasarbu commented Oct 20, 2016 •

edited

Loading

tsg Oct 20, 2016

tsg Oct 20, 2016

tsg Oct 20, 2016

tsg Oct 20, 2016

monicasarbu Oct 21, 2016

tsg Oct 20, 2016

tsg Oct 20, 2016

dedemorton commented Oct 20, 2016

dedemorton Oct 20, 2016

monicasarbu Oct 20, 2016

monicasarbu Oct 20, 2016

dedemorton Oct 20, 2016 •

edited

Loading

tsg commented Oct 20, 2016

tsg Oct 21, 2016

tsg Oct 21, 2016

monicasarbu commented Oct 21, 2016

tsg Oct 24, 2016

tsg Oct 24, 2016

tsg Oct 24, 2016

monicasarbu Oct 24, 2016

Combined 5.0.0 release notes #2813

Combined 5.0.0 release notes #2813

Conversation

monicasarbu commented Oct 20, 2016 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dedemorton commented Oct 20, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

dedemorton Oct 20, 2016 • edited Loading

Choose a reason for hiding this comment

tsg commented Oct 20, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monicasarbu commented Oct 21, 2016

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

monicasarbu commented Oct 20, 2016 •

edited

Loading

dedemorton Oct 20, 2016 •

edited

Loading