From 11d37334abb9c612e39a7fd511fc5cb49a3ff44f Mon Sep 17 00:00:00 2001 From: jamie-wilson88 <168847178+jamie-wilson88@users.noreply.github.com> Date: Mon, 24 Nov 2025 12:20:58 -0500 Subject: [PATCH] Update logstash-settings-file.md --- docs/reference/logstash-settings-file.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/logstash-settings-file.md b/docs/reference/logstash-settings-file.md index 197e7e55052..304a1d37b81 100644 --- a/docs/reference/logstash-settings-file.md +++ b/docs/reference/logstash-settings-file.md @@ -45,7 +45,7 @@ The `logstash.yml` file includes these settings. | `node.name` | A descriptive name for the node. | Machine’s hostname | | `path.data` | The directory that Logstash and its plugins use for any persistent needs. | `LOGSTASH_HOME/data` | | `pipeline.id` | The ID of the pipeline. | `main` | -| `pipeline.workers` | The number of workers that will, in parallel, execute the filter and outputstages of the pipeline. This setting uses the[`java.lang.Runtime.getRuntime.availableProcessors`](https://docs.oracle.com/javase/7/docs/api/java/lang/Runtime.md#availableProcessors())value as a default if not overridden by `pipeline.workers` in `pipelines.yml` or`pipeline.workers` from `logstash.yml`. If you have modified this setting andsee that events are backing up, or that the CPU is not saturated, considerincreasing this number to better utilize machine processing power. | Number of the host’s CPU cores | +| `pipeline.workers` | The number of workers that will, in parallel, execute the filter and output stages of the pipeline. This setting uses the[`java.lang.Runtime.getRuntime.availableProcessors`](https://docs.oracle.com/javase/7/docs/api/java/lang/Runtime.md#availableProcessors())value as a default if not overridden by `pipeline.workers` in `pipelines.yml` or`pipeline.workers` from `logstash.yml`. If you have modified this setting and see that events are backing up, or that the CPU is not saturated, consider increasing this number to better utilize machine processing power. | Number of the host’s CPU cores | | `pipeline.batch.size` | The maximum number of events an individual worker thread will collect from inputs before attempting to execute its filters and outputs. Larger batch sizes are generally more efficient, but come at the cost of increased memory overhead. You may need to increase JVM heap space in the `jvm.options` config file. See [Logstash Configuration Files](/reference/config-setting-files.md) for more info. | `125` | | `pipeline.batch.delay` | When creating pipeline event batches, how long in milliseconds to wait for each event before dispatching an undersized batch to pipeline workers. | `50` | | `pipeline.batch.metrics.sampling_mode` {applies_to}`stack: preview 9.2.0`| Controls frequency of collection of batch size metrics. These metrics measure the actual number of events and byte size of batches processed through a pipeline. This can be helpful to tune `pipeline.batch.size` to reflect the actual batch sizes processed.

Note: This feature is in **technical preview** and may change in the future.

Current options are:

* `disabled`: disabling the collection.
* `minimal`: calculate based on a subset of batches.(default)
* `full`: calculate based on every processed batch.
| `minimal` |