Skip to content

Commit 9f62939

Browse files
Apply suggestions from code review
Co-authored-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> Signed-off-by: Alexa Kreizinger <alexakreizinger@gmail.com>
1 parent c478265 commit 9f62939

30 files changed

+42
-36
lines changed

pipeline/inputs/collectd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The plugin supports the following configuration parameters:
1111
| Listen | Set the address to listen to | 0.0.0.0 |
1212
| Port | Set the port to listen to | 25826 |
1313
| TypesDB | Set the data specification file | /usr/share/collectd/types.db |
14-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
14+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1515

1616
## Configuration Examples <a id="config_example"></a>
1717

pipeline/inputs/cpu-metrics.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@ The **cpu** input plugin, measures the CPU usage of a process or the whole syste
44

55
The following tables describes the information generated by the plugin. The keys below represent the data used by the overall system, all values associated to the keys are in a percentage unit \(0 to 100%\):
66

7-
The CPU metrics plugin creates metrics that are log-based \(I.e. JSON payload\). If you are looking for Prometheus-based metrics please see the Node Exporter Metrics input plugin.
7+
The CPU metrics plugin creates metrics that are log-based, such as JSON payload. For
8+
Prometheus-based metrics, see the Node Exporter Metrics input plugin.
89

910
| key | description |
1011
| :--- | :--- |

pipeline/inputs/disk-io-metrics.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
The **disk** input plugin, gathers the information about the disk throughput of the running system every certain interval of time and reports them.
44

5-
The Disk I/O metrics plugin creates metrics that are log-based \(I.e. JSON payload\). If you are looking for Prometheus-based metrics please see the Node Exporter Metrics input plugin.
5+
The Disk I/O metrics plugin creates metrics that are log-based, such as JSON payload.
6+
For Prometheus-based metrics, see the Node Exporter Metrics input plugin.
67

78
## Configuration Parameters
89

@@ -13,7 +14,7 @@ The plugin supports the following configuration parameters:
1314
| Interval\_Sec | Polling interval \(seconds\). | 1 |
1415
| Interval\_NSec | Polling interval \(nanosecond\). | 0 |
1516
| Dev\_Name | Device name to limit the target. \(e.g. sda\). If not set, _in\_disk_ gathers information from all of disks and partitions. | all disks |
16-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
17+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1718

1819
## Getting Started
1920

pipeline/inputs/docker-events.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This plugin supports the following configuration parameters:
1414
| Key | When a message is unstructured \(no parser applied\), it's appended as a string under the key name _message_. | message |
1515
| Reconnect.Retry_limits| The maximum number of retries allowed. The plugin tries to reconnect with docker socket when EOF is detected. | 5 |
1616
| Reconnect.Retry_interval| The retrying interval. Unit is second. | 1 |
17-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
17+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1818

1919
### Command Line
2020

pipeline/inputs/docker-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The plugin supports the following configuration parameters:
1515
| Interval_Sec | Polling interval in seconds | 1 |
1616
| Include | A space-separated list of containers to include | |
1717
| Exclude | A space-separated list of containers to exclude | |
18-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
18+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1919

2020
If you set neither `Include` nor `Exclude`, the plugin will try to get metrics from _all_ the running containers.
2121

pipeline/inputs/dummy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The plugin supports the following configuration parameters:
1818
| Samples | If set, the events number will be limited. For example, if Samples=3, the plugin generates only three events and stops. | _none_ |
1919
| Copies | Number of messages to generate each time they are generated. | `1` |
2020
| Flush\_on\_startup | If set to `true`, the first dummy event is generated at startup. | `false` |
21-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
21+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2222

2323
## Getting Started
2424

pipeline/inputs/elasticsearch.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ The plugin supports the following configuration parameters:
1414
| meta\_key | Specify a key name for meta information. | "@meta" |
1515
| hostname | Specify hostname or FQDN. This parameter can be used for "sniffing" (auto-discovery of) cluster node information. | "localhost" |
1616
| version | Specify Elasticsearch server version. This parameter is effective for checking a version of Elasticsearch/OpenSearch server version. | "8.0.0" |
17-
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
17+
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1818

1919
**Note:** The Elasticsearch cluster uses "sniffing" to optimize the connections between its cluster and clients.
2020
Elasticsearch can build its cluster and dynamically generate a connection list which is called "sniffing".

pipeline/inputs/fluentbit-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ They can be sent to output plugins including [Prometheus Exporter](../outputs/pr
1818
| --------------- | --------------------------------------------------------------------------------------------------------- | --------- |
1919
| scrape_interval | The rate at which metrics are collected from the host operating system | 2 seconds |
2020
| scrape_on_start | Scrape metrics upon start, useful to avoid waiting for 'scrape_interval' for the first round of metrics. | false |
21-
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
21+
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2222

2323

2424
## Getting Started

pipeline/inputs/forward.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The plugin supports the following configuration parameters:
2020
| Shared\_Key | Shared key for secure forward authentication. | |
2121
| Self\_Hostname | Hostname for secure forward authentication. | |
2222
| Security.Users | Specify the username and password pairs for secure forward authentication. | |
23-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
23+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2424

2525
## Getting Started
2626

pipeline/inputs/http.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ description: The HTTP input plugin allows you to send custom records to an HTTP
1515
| buffer_chunk_size | This sets the chunk size for incoming incoming JSON messages. These chunks are then stored/managed in the space available by buffer_max_size. | 512K |
1616
| successful_response_code | It allows to set successful response code. `200`, `201` and `204` are supported. | 201 |
1717
| success_header | Add an HTTP header key/value pair on success. Multiple headers can be set. Example: `X-Custom custom-answer` | |
18-
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
18+
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1919

2020
### TLS / SSL
2121

pipeline/inputs/kafka.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This plugin uses the official [librdkafka C library](https://github.com/edenhill
1515
| poll\_ms | Kafka brokers polling interval in milliseconds. | 500 |
1616
| Buffer\_Max\_Size | Specify the maximum size of buffer per cycle to poll kafka messages from subscribed topics. To increase throughput, specify larger size. | 4M |
1717
| rdkafka.{property} | `{property}` can be any [librdkafka properties](https://github.com/edenhill/librdkafka/blob/master/CONFIGURATION.md) | |
18-
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
18+
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1919

2020
## Getting Started
2121

@@ -46,7 +46,8 @@ In your main configuration file append the following _Input_ & _Output_ sections
4646

4747
#### Example of using kafka input/output plugins
4848

49-
The fluent-bit source repository contains a full example of using fluent-bit to process kafka records:
49+
The Fluent Bit source repository contains a full example of using Fluent Bit to
50+
process Kafka records:
5051

5152
```text
5253
[INPUT]

pipeline/inputs/kernel-logs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ The **kmsg** input plugin reads the Linux Kernel log buffer since the beginning,
77
| Key | Description | Default |
88
| :--- | :--- | :--- |
99
| Prio_Level | The log level to filter. The kernel log is dropped if its priority is more than prio_level. Allowed values are 0-8. Default is 8. 8 means all logs are saved. | 8 |
10-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
10+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1111

1212
## Getting Started
1313

pipeline/inputs/network-io-metrics.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
The **netif** input plugin gathers network traffic information of the running system every certain interval of time, and reports them.
44

5-
The Network I/O Metrics plugin creates metrics that are log-based \(I.e. JSON payload\). If you are looking for Prometheus-based metrics please see the Node Exporter Metrics input plugin.
5+
The Network I/O Metrics plugin creates metrics that are log-based, such as JSON
6+
payload. For Prometheus-based metrics, see the Node Exporter Metrics input plugin.
67

78
## Configuration Parameters
89

@@ -15,7 +16,7 @@ The plugin supports the following configuration parameters:
1516
| Interval\_NSec | Polling interval \(nanosecond\). | 0 |
1617
| Verbose | If true, gather metrics precisely. | false |
1718
| Test\_At\_Init | If true, testing if the network interface is valid at initialization. | false |
18-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
19+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1920

2021
## Getting Started
2122

pipeline/inputs/nginx.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The plugin supports the following configuration parameters:
1212
| Port | Port of the target nginx service to connect to. | 80 |
1313
| Status_URL | The URL of the Stub Status Handler. | /status |
1414
| Nginx_Plus | Turn on NGINX plus mode. | true |
15-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
15+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1616

1717
## Getting Started
1818

@@ -36,8 +36,8 @@ server {
3636

3737
### Configuration with NGINX Plus REST API
3838

39-
A much more powerful and flexible metrics API is available with NGINX Plus. A path needs to be configured
40-
in NGINX Plus first.
39+
Another metrics API is available with NGINX Plus. You must first configure a path in
40+
NGINX Plus.
4141

4242
```
4343
server {

pipeline/inputs/opentelemetry.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Our compliant implementation fully supports OTLP/HTTP and OTLP/GRPC. Note that t
2020
| buffer_chunk_size | Initial size and allocation strategy to store the payload (advanced users only) | 512K |
2121
|successful_response_code | It allows to set successful response code. `200`, `201` and `204` are supported.| 201 |
2222
| tag_from_uri | If true, tag will be created from uri. e.g. v1_metrics from /v1/metrics . | true |
23-
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
23+
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2424

2525
Important note: Raw traces means that any data forwarded to the traces endpoint (`/v1/traces`) will be packed and forwarded as a log message, and will NOT be processed by Fluent Bit. The traces endpoint by default expects a valid protobuf encoded payload, but you can set the `raw_traces` option in case you want to get trace telemetry data to any of Fluent Bit's supported outputs.
2626

pipeline/inputs/podman-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ description: The Podman Metrics input plugin allows you to collect metrics from
1313
| path.config | Custom path to podman containers configuration file | /var/lib/containers/storage/overlay-containers/containers.json |
1414
| path.sysfs | Custom path to sysfs subsystem directory | /sys/fs/cgroup |
1515
| path.procfs | Custom path to proc subsystem directory | /proc |
16-
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
16+
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1717

1818
## Getting Started
1919

pipeline/inputs/process-exporter-metrics.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -87,7 +87,8 @@ curl http://127.0.0.1:2021/metrics
8787
### Container to Collect Host Metrics
8888

8989
When deploying Fluent Bit in a container you will need to specify additional settings to ensure that Fluent Bit has access to the process details.
90-
The following `docker` command deploys Fluent Bit with a specific mount path for `procfs` and settings enabled to ensure that Fluent Bit can collect from the host.
90+
The following `docker` command deploys Fluent Bit with a specific mount path for
91+
`procfs` and settings enabled to ensure that Fluent Bit can collect from the host.
9192
These are then exposed over port 2021.
9293

9394
```

pipeline/inputs/process.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@
33

44
_Process_ input plugin allows you to check how healthy a process is. It does so by performing a service check at every certain interval of time specified by the user.
55

6-
The Process metrics plugin creates metrics that are log-based \(I.e. JSON payload\). If you are looking for Prometheus-based metrics please see the Node Exporter Metrics input plugin.
6+
The Process metrics plugin creates metrics that are log-based, such as JSON payload.
7+
For Prometheus-based metrics, see the Node Exporter Metrics input plugin.
78

89
## Configuration Parameters
910

pipeline/inputs/prometheus-remote-write.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This input plugin allows you to ingest a payload in the Prometheus remote-write
1717
|successful\_response\_code | It allows to set successful response code. `200`, `201` and `204` are supported.| 201 |
1818
| tag\_from\_uri | If true, tag will be created from uri, e.g. api\_prom\_push from /api/prom/push, and any tag specified in the config will be ignored. If false then a tag must be provided in the config for this input. | true |
1919
| uri | Specify an optional HTTP URI for the target web server listening for prometheus remote write payloads, e.g: /api/prom/push | |
20-
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
20+
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2121

2222

2323
A sample config file to get started will look something like the following:

pipeline/inputs/prometheus-scrape-metrics.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ The initial release of the Prometheus Scrape metric allows you to collect metric
1212
| port | The port of the prometheus metric endpoint that you want to scrape | |
1313
| scrape\_interval | The interval to scrape metrics | 10s |
1414
| metrics\_path | <p>The metrics URI endpoint, that must start with a forward slash.<br><br>Note: Parameters can also be added to the path by using <code>?</code></p> | /metrics |
15-
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
15+
| threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1616

1717
## Example
1818

pipeline/inputs/splunk.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The **splunk** input plugin handles [Splunk HTTP HEC](https://docs.splunk.com/Do
1313
| buffer_chunk_size | This sets the chunk size for incoming incoming JSON messages. These chunks are then stored/managed in the space available by buffer_max_size. | 512K |
1414
| successful_response_code | It allows to set successful response code. `200`, `201` and `204` are supported. | 201 |
1515
| splunk\_token | Add an Splunk token for HTTP HEC.` | |
16-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
16+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1717

1818
## Getting Started
1919

pipeline/inputs/standard-input.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -204,4 +204,4 @@ The plugin supports the following configuration parameters:
204204
| :--- | :--- | :--- |
205205
| Buffer\_Size | Set the buffer size to read data. This value is used to increase buffer size. The value must be according to the [Unit Size](../../administration/configuring-fluent-bit/unit-sizes.md) specification. | 16k |
206206
| Parser | The name of the parser to invoke instead of the default JSON input parser | |
207-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
207+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |

pipeline/inputs/statsd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ The plugin supports the following configuration parameters:
1515
| :--- | :--- | :--- |
1616
| Listen | Listener network interface. | 0.0.0.0 |
1717
| Port | UDP port where listening for connections | 8125 |
18-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
18+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
1919

2020
## Configuration Examples <a id="config_example"></a>
2121

pipeline/inputs/syslog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ The plugin supports the following configuration parameters:
1818
| Buffer\_Max\_Size | Specify the maximum buffer size to receive a Syslog message. If not set, the default size will be the value of _Buffer\_Chunk\_Size_. | |
1919
| Receive\_Buffer\_Size | Specify the maximum socket receive buffer size. If not set, the default value is OS-dependant, but generally too low to accept thousands of syslog messages per second without loss on _udp_ or _unix\_udp_ sockets. Note that on Linux the value is capped by `sysctl net.core.rmem_max`.| |
2020
| Source\_Address\_Key| Specify the key where the source address will be injected. | |
21-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
21+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2222

2323
### Considerations
2424

pipeline/inputs/systemd.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ The plugin supports the following configuration parameters:
1919
| Read\_From\_Tail | Start reading new entries. Skip entries already stored in Journald. | Off |
2020
| Lowercase | Lowercase the Journald field \(key\). | Off |
2121
| Strip\_Underscores | Remove the leading underscore of the Journald field \(key\). For example the Journald field _\_PID_ becomes the key _PID_. | Off |
22-
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | false |
22+
| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
2323

2424
## Getting Started
2525

0 commit comments

Comments
 (0)