Skip to content

Commit 3c6cbbf

Browse files
authored
Breaking changes for 9.0 (#17380)
1 parent 5a052b3 commit 3c6cbbf

File tree

1 file changed

+73
-0
lines changed

1 file changed

+73
-0
lines changed

docs/release-notes/breaking-changes.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,79 @@ We’ve removed deprecated SSL settings in some {{ls}} plugins, and have replace
196196

197197
::::
198198

199+
200+
### Pipeline buffer type defaults to `heap`[pipeline-buffer-type]
201+
202+
We've improved memory configuration for certain {{ls}} plugins.
203+
Input plugins such as `elastic_agent`, `beats`, `tcp`, and `http` allocate buffers in Java memory to read events from the network.
204+
The default allocation method is `direct` memory rather than `heap` memory to simplify configuration, and to help facilitate debugging memory usage problems through the analysis of heap dumps.
205+
If you need to re-enable the previous behavior, change the `pipeline.buffer.type` setting in [logstash.yml](/reference/logstash-settings-file.md).
206+
Check out [off-heap-buffers-allocation](/reference/jvm-settings.md#off-heap-buffers-allocation) for details. [#16500](https://github.com/elastic/logstash/pull/16500)
207+
208+
### {{ls}} modules removed [removed-modules]
209+
210+
We have removed the {{ls}} modules framework, and encourage users to try Elastic Integrations
211+
This includes the netflow, azure and arcsight modules, and the modules framework as a whole. [#16794](https://github.com/elastic/logstash/pull/16794)
212+
213+
214+
### Deprecated configuration settings removed [removed-params]
215+
216+
We have removed support for previously deprecated configuration settings:
217+
218+
#### `http.*` prefixed settings for the {{ls}} API
219+
When configuring the {{ls}} API, settings prefixed by `http.*` have been replaced by the equivalent settings prefixed with `api.*`. [#16552](https://github.com/elastic/logstash/pull/16552)
220+
221+
#### `event_api.tags.illegal`
222+
223+
Any events that include field named tags automatically rename the field _tags to avoid any clash
224+
with the reserved {{ls}} tags field.
225+
Instead, {{ls}} generates `_tagsparsefailure` in the event `tags` and the illegal value is written to the `_tags` field. [#16461](https://github.com/elastic/logstash/pull/16461)
226+
227+
228+
### Ingest converter removed [removed-ingest-converter]
229+
230+
The ingest converter, which was used to convert ingest pipelines to {{ls}} pipelines, has been removed. [#16453](https://github.com/elastic/logstash/pull/16453)
231+
The `logstash-filter-elastic_integration` plugin offers similar functionality, and can help you use [Logstash to extend Elastic integrations](/reference/using-logstash-with-elastic-integrations.md).
232+
233+
### JDK11 not supported [jdk-11-support-drop]
234+
235+
JDK17 is the minimum version of the JDK required to run Logstash.
236+
For the best experience, we still recommend running {{ls}} using the bundled-jdk.
237+
See [Logstash JVM requirements](/reference/getting-started-with-logstash.md#ls-jvm)
238+
for details. [#16443](https://github.com/elastic/logstash/pull/16443)
239+
240+
### Docker base image now UBI9 based [docker-base-image-change]
241+
242+
The base image for {{ls}} on Docker has been changed from Ubuntu to UBI9.
243+
If you create a Docker image based on the {{ls}} image and rely on it being Ubuntu based, you need to change your derived image to take account of this change.
244+
For example, if your derived docker image installs additional packages using a package manager, UBI9 uses `microdnf`, rather than `apt`.
245+
[#16599](https://github.com/elastic/logstash/pull/16599)
246+
247+
248+
### Cannot run {{ls}} as `superuser` by default [disallow-superuser]
249+
250+
We've changed the default behavior to prevent users from accidentally running {{ls}} as a superuser.
251+
If you try to run {{ls}} as a superuser, it logs an error and fails to start, ensuring that users cannot run Logstash with elevated privileges by accident.
252+
253+
You can change the value of the `allow_superuser` setting to `true` in [logstash.yml](/reference/logstash-settings-file.md) if you want to restore the previous behavior and allow {{ls}} to run with superuser privileges. [#16558(https://github.com/elastic/logstash/pull/16558)
254+
255+
### New setting required to continue using legacy internal monitoring [allow-legacy-monitoring]
256+
257+
To continue using deprecated internal collection to monitor {{ls}}, set `xpack.monitoring.allow_legacy_collection` to `true` in [logstash.yml](/reference/logstash-settings-file.md).
258+
We encourage you to move to [agent-driven monitoring](/reference/monitoring-logstash-with-elastic-agent.md), the latest, supported way to monitor Logstash [#16586](https://github.com/elastic/logstash/pull/16586)
259+
260+
261+
### Avoiding JSON log lines collision [avoid-collision-on-json-fields]
262+
263+
We've improved the way we deal with duplicate `message` fields in `json` documents.
264+
Some code paths that log in `json` produce log events that include multiple instances of the `message` field. (The JSON codec plugin is one example.)
265+
While this approach produces JSON that is technically valid, many clients do not parse this data correctly, and either crash or discard one of the fields.
266+
267+
We recently introduced the option to fix duplicates, and made it the default behavior for `9.0` and later.
268+
To re-enable the previous behavior, change the `log.format.json.fix_duplicate_message_fields` setting in [logstash.yml](/reference/logstash-settings-file.md) to `false`.
269+
270+
Check out [Logging in json format can write duplicate message fields](docs-content://troubleshoot/ingest/logstash.md) for more details about the issue. [#16578](https://github.com/elastic/logstash/pull/16578)
271+
199272
### Enterprise_search integration plugin is deprecated [enterprise_search-deprecated-9.0]
200273

201274
We’ve deprecated the {{ls}} Enterprise_search integration plugin, and its component App Search and Workplace Search plugins. These plugins will receive only security updates and critical fixes moving forward.

0 commit comments

Comments
 (0)