Skip to content

output: docs for default workers setting (#716) #717

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 17, 2022
Merged

output: docs for default workers setting (#716) #717

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion pipeline/outputs/elasticsearch.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,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

Expand Down
6 changes: 4 additions & 2 deletions pipeline/outputs/file.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +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

Expand Down
1 change: 1 addition & 0 deletions pipeline/outputs/forward.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
45 changes: 23 additions & 22 deletions pipeline/outputs/http.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,28 +4,29 @@ The **http** output plugin allows to flush your records into a HTTP endpoint. Fo

## Configuration Parameters

| Key | Description | default |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| host | IP address or hostname of the target HTTP Server | 127.0.0.1 |
| http\_User | Basic Auth Username | |
| http\_Passwd | Basic Auth Password. Requires HTTP\_User to be set | |
| port | TCP port of the target HTTP Server | 80 |
| Proxy | Specify an HTTP Proxy. The expected format of this value is [http://host:port](http://host/:port). Note that _https_ is **not** supported yet. Please consider not setting this and use `HTTP_PROXY` environment variable instead, which supports both http and https. | |
| uri | Specify an optional HTTP URI for the target web server, e.g: /something | / |
| compress | Set payload compression mechanism. Option available is 'gzip' | |
| format | Specify the data format to be used in the HTTP request body, by default it uses _msgpack_. Other supported formats are _json_, _json\_stream_ and _json\_lines_ and _gelf_. | msgpack |
| allow\_duplicated\_headers | Specify if duplicated headers are allowed. If a duplicated header is found, the latest key/value set is preserved. | true |
| log\_response\_payload | Specify if the response paylod should be logged or not. | true |
| header\_tag | Specify an optional HTTP header field for the original message tag. | |
| header | Add a HTTP header key/value pair. Multiple headers can be set. | |
| 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 |
| gelf\_timestamp\_key | Specify the key to use for `timestamp` in _gelf_ format | |
| gelf\_host\_key | Specify the key to use for the `host` in _gelf_ format | |
| gelf\_short\_message\_key | Specify the key to use as the `short` message in _gelf_ format | |
| 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) | |
| Key | Description | default |
| -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |
| host | IP address or hostname of the target HTTP Server | 127.0.0.1 |
| http\_User | Basic Auth Username | |
| http\_Passwd | Basic Auth Password. Requires HTTP\_User to be set | |
| port | TCP port of the target HTTP Server | 80 |
| Proxy | Specify an HTTP Proxy. The expected format of this value is `http://HOST:PORT`. Note that HTTPS is **not** currently supported. It is recommended not to set this and to configure the [HTTP proxy environment variables](https://docs.fluentbit.io/manual/administration/http-proxy) instead as they support both HTTP and HTTPS. | |
| uri | Specify an optional HTTP URI for the target web server, e.g: /something | / |
| compress | Set payload compression mechanism. Option available is 'gzip' | |
| format | Specify the data format to be used in the HTTP request body, by default it uses _msgpack_. Other supported formats are _json_, _json\_stream_ and _json\_lines_ and _gelf_. | msgpack |
| allow\_duplicated\_headers | Specify if duplicated headers are allowed. If a duplicated header is found, the latest key/value set is preserved. | true |
| log\_response\_payload | Specify if the response paylod should be logged or not. | true |
| header\_tag | Specify an optional HTTP header field for the original message tag. | |
| header | Add a HTTP header key/value pair. Multiple headers can be set. | |
| 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 |
| gelf\_timestamp\_key | Specify the key to use for `timestamp` in _gelf_ format | |
| gelf\_host\_key | Specify the key to use for the `host` in _gelf_ format | |
| gelf\_short\_message\_key | Specify the key to use as the `short` message in _gelf_ format | |
| 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

Expand Down
Loading