output: docs for default workers setting (#716)

* output: elasticsearch: add default for Workers Signed-off-by: lecaros <[email protected]> * output: file: add default for Workers Signed-off-by: lecaros <[email protected]> * output: forward: add default for Workers Signed-off-by: lecaros <[email protected]> * output: http: add default for Workers Signed-off-by: lecaros <[email protected]> * output: prometheus_remote_write: add default for Workers Signed-off-by: lecaros <[email protected]> * output: splunk: add default for Workers Signed-off-by: lecaros <[email protected]> * output: stackdriver: add default for Workers Signed-off-by: lecaros <[email protected]> * output: stdout: add default for Workers Signed-off-by: lecaros <[email protected]> * output: tcp: add default for Workers Signed-off-by: lecaros <[email protected]>
fluent · Feb 17, 2022 · a22cdf5 · a22cdf5
1 parent ce334c6
commit a22cdf5
Show file tree

Hide file tree

Showing 9 changed files with 12 additions and 3 deletions.
diff --git a/pipeline/outputs/elasticsearch.md b/pipeline/outputs/elasticsearch.md
@@ -43,8 +43,9 @@ The **es** output plugin, allows to ingest your records into an [Elasticsearch](
 | Current\_Time\_Index | Use current time for index generation instead of message record | Off |
 | Logstash\_Prefix\_Key | When included: the value in the record that belongs to the key will be looked up and over-write the Logstash\_Prefix for index generation. If the key/value is not found in the record then the Logstash\_Prefix option will act as a fallback. Nested keys are not supported \(if desired, you can use the nest filter plugin to remove nesting\) |  |
 | Suppress\_Type\_Name | When enabled, mapping types is removed and `Type` option is ignored. Types are deprecated in APIs in [v7.0](https://www.elastic.co/guide/en/elasticsearch/reference/current/removal-of-types.html). This options is for v7.0 or later. | Off |
+| Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.12. For previous versions is 0. | 2 |
 
-> The parameters _index_ and _type_ can be confusing if you are new to Elastic, if you have used a common relational database before, they can be compared to the _database_ and _table_ concepts. Also see [the FAQ below](elasticsearch.md#faq-multiple-types)
+> The parameters _index_ and _type_ can be confusing if you are new to Elastic, if you have used a common relational database before, they can be compared to the _database_ and _table_ concepts. Also see [the FAQ below](elasticsearch.md#faq)
 
 ### TLS / SSL
 

diff --git a/pipeline/outputs/file.md b/pipeline/outputs/file.md
@@ -6,12 +6,13 @@ The **file** output plugin allows to write the data received through the _input_
 
 The plugin supports the following configuration parameters:
 
-| Key | Description |
-| :--- | :--- |
+| Key | Description | Default |
+| :--- | :--- | :--- |
 | Path | Directory path to store files. If not set, Fluent Bit will write the files on it's own positioned directory. note: this option was added on Fluent Bit v1.4.6 |
 | File | Set file name to store the records. If not set, the file name will be the _tag_ associated with the records. |
 | Format | The format of the file content. See also Format section. Default: out\_file. |
 | Mkdir | Recursively create output directory if it does not exist. Permissions set to 0755. |
+| Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.12. For previous versions is 0. | 1 |
 
 ## Format
 

diff --git a/pipeline/outputs/forward.md b/pipeline/outputs/forward.md
@@ -21,6 +21,7 @@ The following parameters are mandatory for either Forward for Secure Forward mod
 | Send_options         | Always send options (with "size"=count of messages)                                                                                                                                                                                                                                                 | False     |
 | Require_ack_response | Send "chunk"-option and wait for "ack" response from server. Enables at-least-once and receiving server can control rate of traffic. (Requires Fluentd v0.14.0+ server)                                                                                                                             | False     |
 | Compress             | Set to "gzip" to enable gzip compression. Incompatible with Time_as_Integer=True and tags set dynamically using the [Rewrite Tag](https://app.gitbook.com/s/-LKKSx-3LBTCtaHbg0gl-887967055/pipeline/filters/rewrite-tag.md) filter. (Requires Fluentd v0.14.7+ server)                              |           |
+| Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.12. For previous versions is 0. | 2 |
 
 ## Secure Forward Mode Configuration Parameters
 

diff --git a/pipeline/outputs/http.md b/pipeline/outputs/http.md
@@ -26,6 +26,7 @@ The **http** output plugin allows to flush your records into a HTTP endpoint. Fo
 | gelf\_full\_message\_key   | Specify the key to use for the `full` message in _gelf_ format                                                                                                                                                                                                                                                                     |           |
 | gelf\_level\_key           | Specify the key to use for the `level` in _gelf_ format                                                                                                                                                                                                                                                                            |           |
 | successful\_response\_code | Specify what a successful HTTP response code is in case you need to retry for other HTTP codes (E.g. 204 where)                                                                                                                                                                                                                    |           |
+| Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.12. For previous versions is 0. | 2 |
 
 ### TLS / SSL
 

diff --git a/pipeline/outputs/prometheus-remote-write.md b/pipeline/outputs/prometheus-remote-write.md
@@ -19,6 +19,7 @@ Important Note: The prometheus exporter only works with metric plugins, such as
 | header               | Add a HTTP header key/value pair. Multiple headers can be set.                                                                                                                                                                                                         |           |
 | log_response_payload | Log the response payload within the Fluent Bit log                                                                                                                                                                                                                     | false     |
 | add_label            | This allows you to add custom labels to all metrics exposed through the prometheus exporter. You may have multiple of these fields                                                                                                                                     |           |
+| Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.12. For previous versions is 0. | 2 |
 
 ## Getting Started
 

diff --git a/pipeline/outputs/splunk.md b/pipeline/outputs/splunk.md
@@ -22,6 +22,7 @@ Connectivity, transport and authentication configuration properties:
 | http\_buffer\_size | Buffer size used to receive Splunk HTTP responses | 2M |
 | compress | Set payload compression mechanism. The only available option is `gzip`. |  |
 | channel | Specify X-Splunk-Request-Channel Header for the HTTP Event Collector interface. |  |
+| Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.12. For previous versions is 0. | 2 |
 
 Content and Splunk metadata \(fields\) handling configuration properties:
 

diff --git a/pipeline/outputs/stackdriver.md b/pipeline/outputs/stackdriver.md
@@ -29,6 +29,7 @@ Before to get started with the plugin configuration, make sure to obtain the pro
 | tag\_prefix | Set the tag\_prefix used to validate the tag of logs with k8s resource type. Without this option, the tag of the log must be in format of k8s\_container\(pod/node\).\* in order to use the k8s\_container resource type. Now the tag prefix is configurable by this option \(note the ending dot\). | k8s\_container., k8s\_pod., k8s\_node. |
 | severity\_key | Specify the name of the key from the original record that contains the severity information. |  |
 | autoformat\_stackdriver\_trace | Rewrite the _trace_ field to include the projectID and format it for use with Cloud Trace. When this flag is enabled, the user can get the correct result by printing only the traceID (usually 32 characters). | false |
+| Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.12. For previous versions is 0. | 2 |
 
 ### Configuration File
 

diff --git a/pipeline/outputs/standard-output.md b/pipeline/outputs/standard-output.md
@@ -9,6 +9,7 @@ The **stdout** output plugin allows to print to the standard output the data rec
 | Format | Specify the data format to be printed. Supported formats are _msgpack_ _json_, _json\_lines_ and _json\_stream_. | msgpack |
 | json\_date\_key | Specify the name of the time key in the output record. To disable the time key just set the value to `false`. | date |
 | json\_date\_format | Specify the format of the date. Supported formats are _double_, _epoch_ and _iso8601_ \(eg: _2018-05-30T09:39:52.000681Z_\) | double |
+| Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.12. For previous versions is 0. | 1 |
 
 ### Command Line
 

diff --git a/pipeline/outputs/tcp-and-tls.md b/pipeline/outputs/tcp-and-tls.md
@@ -11,6 +11,7 @@ The **tcp** output plugin allows to send records to a remote TCP server. The pay
 | Format | Specify the data format to be printed. Supported formats are _msgpack_ _json_, _json\_lines_ and _json\_stream_. | msgpack |
 | json\_date\_key | Specify the name of the time key in the output record. To disable the time key just set the value to `false`. | date |
 | json\_date\_format | Specify the format of the date. Supported formats are _double_, _epoch_ and _iso8601_ \(eg: _2018-05-30T09:39:52.000681Z_\) | double |
+| Workers | Enables dedicated thread(s) for this output. Default value is set since version 1.8.12. For previous versions is 0. | 2 |
 
 ## TLS Configuration Parameters