Doc: Add json_lines known issue to release notes #16831
Conversation
|
@robbavey @yaauie, I'm getting this draft up so that you can see what you think about the content and presentation. Meanwhile, I'll continue to work on this, adding links where appropriate, etc. You'll notice that I reworked the existing known issue, too, so please keep me honest that I got everything right. I know that this content needs to go other places in this branch. Let's get the content right, and then I'll add it to other sections before final signoff |
docs/static/releasenotes.asciidoc
Outdated
| **Solution:** Apply the default change contained in the newer 'jvm.options' file, as seen in this https://github.com/elastic/logstash/blob/main/config/jvm.options#L66-L82[example]. | ||
|
|
||
| [[known-issue-8-17-0-json_lines]] | ||
| ===== Error with `json_lines` codec 3.2.0 (or earlier) and {ls} 8.17.1 (or earlier) |
There was a problem hiding this comment.
| ===== Error with `json_lines` codec 3.2.0 (or earlier) and {ls} 8.17.1 (or earlier) | |
| ===== Error with `json_lines` codec 3.2.0 (or later) with {ls} 8.17.0 |
and {ls} 8.17.1 (or earlier) - part is a bit confusing to me. I support removing LS version from this title which brings reader to "... present in {ls} versions 8.16.0, 8.16.1, and 8.17.0." and to mitigation section.
There was a problem hiding this comment.
This was based on description in issue: "When using the json_lines codec > 3.2.0 with versions of Logstash < 8.17.1, the following error may be emitted, crashing the pipelines"
If that's not accurate, I'll update it here, and it will also need to be updated in the issue.
There was a problem hiding this comment.
What do you think about using the symptom as the heading, rather than json_lines codec?
===== "Input Buffer Full" error With Logstash `8.17.0`, `8.16.1` and `8.16.0`
Then describe the instances of what happens when this error occurs, how this would happen and how to mitigate, with Logstash->Logstash communication first, as it is the most likely, then the json_lines case?
Leading with json_lines isn't necessarily obvious as the codec is used "silently" by the Logstash integration plugin.
docs/static/releasenotes.asciidoc
Outdated
| **Solution:** Apply the default change contained in the newer 'jvm.options' file, as seen in this https://github.com/elastic/logstash/blob/main/config/jvm.options#L66-L82[example]. | ||
|
|
||
| [[known-issue-8-17-0-json_lines]] | ||
| ===== Error with `json_lines` codec 3.2.0 (or earlier) and {ls} 8.17.1 (or earlier) |
There was a problem hiding this comment.
| ===== Error with `json_lines` codec 3.2.0 (or earlier) and {ls} 8.17.1 (or earlier) | |
| ===== Error with `json_lines` codec 3.2.0 (or later) and {ls} 8.17.1 (or earlier) |
Based on description in the issue, I think this should be 3.2.0 or later for json_lines?
There was a problem hiding this comment.
Yup, json_lines codec >= 3.2.0 versions which have an ability to set the buffer limit.
Co-authored-by: Rob Bavey <[email protected]>
| ==== Known issue | ||
|
|
||
| [[known-issue-8-16-1-json_lines]] | ||
| ===== "Input buffer full" error with {ls} 8.16.0, 8.16.1, or 8.17.0 |
There was a problem hiding this comment.
It seems kinda weird to have 8.17.0 listed in the 8.16.1 and 8.16.0 release notes.
However, this information is complete and correct, and I'm inclined to leave it. LMKWYT.
Note to self @karenzone: Make sure any change here gets propagated to 8.16.1 and 8.16.0 sections.
There was a problem hiding this comment.
It does, and it's not something we typically do.
However, the fact that this is not affected in 8.16.2 may make this appropriate to be explicit about which versions are affected to ensure that users are not confused, and don't think we have just missed 8.16.2.
It's something that could affect us in the future, as we support multiple branches, and the bug story isn't as simple as it used to be, so it's probably up for debate how we want to approach this from a messaging standpoint.
|
Pending decisions and approvals. Ping me when we're ready to move on this again. |
Related: #16821
Closes: #16822
PREVIEW: https://logstash_bk_16831.docs-preview.app.elstc.co/guide/en/logstash/current/logstash-8-17-0.html