Input plugins standardized code indentation and table formatting fixed. Fixes #1954

pipeline/inputs/collectd.md

@@ -6,12 +6,12 @@ The _Collectd_ input plugin lets you receive datagrams from the `collectd` servi
 
 The plugin supports the following configuration parameters:
 
-| Key | Description | Default |
-| :--- | :--- | :--- |
-| `Listen` | Set the address to listen to. | `0.0.0.0` |
-| `Port` | Set the port to listen to. | `25826` |
-| `TypesDB` | Set the data specification file. | `/usr/share/collectd/types.db` |
-| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
+| Key        | Description                                                                                             | Default                        |
+|:-----------|:--------------------------------------------------------------------------------------------------------|:-------------------------------|
+| `Listen`   | Set the address to listen to.                                                                           | `0.0.0.0`                      |
+| `Port`     | Set the port to listen to.                                                                              | `25826`                        |
+| `TypesDB`  | Set the data specification file.                                                                        | `/usr/share/collectd/types.db` |
+| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false`                        |
 
 ## Configuration examples
 
@@ -22,30 +22,30 @@ Here is a basic configuration example:
 
 ```yaml
 pipeline:
-    inputs:
-        - name: collectd
-          listen: 0.0.0.0
-          port: 25826
-          typesdb: '/user/share/collectd/types.db,/etc/collectd/custom.db'
-
-    outputs:
-        - name: stdout
-          match: '*'
+  inputs:
+    - name: collectd
+      listen: 0.0.0.0
+      port: 25826
+      typesdb: '/user/share/collectd/types.db,/etc/collectd/custom.db'
+
+  outputs:
+    - name: stdout
+      match: '*'
 ```
 
 {% endtab %}
 {% tab title="fluent-bit.conf" %}
 
 ```text
 [INPUT]
-    Name         collectd
-    Listen       0.0.0.0
-    Port         25826
-    TypesDB      /usr/share/collectd/types.db,/etc/collectd/custom.db
+  Name         collectd
+  Listen       0.0.0.0
+  Port         25826
+  TypesDB      /usr/share/collectd/types.db,/etc/collectd/custom.db
 
 [OUTPUT]
-    Name   stdout
-    Match  *
+  Name   stdout
+  Match  *
 ```
 
 {% endtab %}

pipeline/inputs/cpu-metrics.md

@@ -6,30 +6,30 @@ The following tables describe the information generated by the plugin. The follo
 
 The CPU metrics plugin creates metrics that are log-based, such as JSON payload. For Prometheus-based metrics, see the _Node Exporter Metrics_ input plugin.
 
-| Key | Description |
-| :--- | :--- |
-| `cpu_p` | CPU usage of the overall system, this value is the summation of time spent on user and kernel space. The result takes in consideration the numbers of CPU cores in the system. |
-| `user_p` | CPU usage in User mode, for short it means the CPU usage by user space programs. The result of this value takes in consideration the numbers of CPU cores in the system. |
-| `system_p` | CPU usage in Kernel mode, for short it means the CPU usage by the Kernel. The result of this value takes in consideration the numbers of CPU cores in the system. |
-| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`. |
+| Key        | Description                                                                                                                                                                    |
+|:-----------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `cpu_p`    | CPU usage of the overall system, this value is the summation of time spent on user and kernel space. The result takes in consideration the numbers of CPU cores in the system. |
+| `user_p`   | CPU usage in User mode, for short it means the CPU usage by user space programs. The result of this value takes in consideration the numbers of CPU cores in the system.       |
+| `system_p` | CPU usage in Kernel mode, for short it means the CPU usage by the Kernel. The result of this value takes in consideration the numbers of CPU cores in the system.              |
+| `threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). Default: `false`.                                                      |
 
 In addition to the keys reported in the previous table, a similar content is created per CPU core. The cores are listed from `0` to `N` as the Kernel reports:
 
-| Key | Description |
-| :--- | :--- |
-| `cpuN.p_cpu` | Represents the total CPU usage by core `N`. |
-| `cpuN.p_user` | Total CPU spent in user mode or user space programs associated to this core. |
-| `cpuN.p_system` | Total CPU spent in system or kernel mode associated to this core. |
+| Key             | Description                                                                  |
+|:----------------|:-----------------------------------------------------------------------------|
+| `cpuN.p_cpu`    | Represents the total CPU usage by core `N`.                                  |
+| `cpuN.p_user`   | Total CPU spent in user mode or user space programs associated to this core. |
+| `cpuN.p_system` | Total CPU spent in system or kernel mode associated to this core.            |
 
 ## Configuration parameters
 
 The plugin supports the following configuration parameters:
 
-| Key | Description | Default |
-| :--- | :--- | :--- |
-| `Interval_Sec` | Polling interval in seconds. | `1` |
-| `Interval_NSec | Polling interval in nanoseconds` | `0` |
-| `PID` | Specify the `ID` (`PID`) of a running process in the system. By default, the plugin monitors the whole system but if this option is set, it will only monitor the given process ID. | _none_ |
+| Key            | Description                                                                                                                                                                         | Default |
+|:---------------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:--------|
+| `Interval_Sec` | Polling interval in seconds.                                                                                                                                                        | `1`     |
+| `Interval_NSec | Polling interval in nanoseconds`                                                                                                                                                    | `0`     |
+| `PID`          | Specify the `ID` (`PID`) of a running process in the system. By default, the plugin monitors the whole system but if this option is set, it will only monitor the given process ID. | _none_  |
 
 ## Get started
 
@@ -46,17 +46,12 @@ build/bin/fluent-bit -i cpu -t my_cpu -o stdout -m '*'
 The command returns results similar to the following:
 
 ```text
-Fluent Bit v1.x.x
-* Copyright (C) 2019-2020 The Fluent Bit Authors
-* Copyright (C) 2015-2018 Treasure Data
-* Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
-* https://fluentbit.io
-
-[2019/09/02 10:46:29] [ info] starting engine
+...
 [0] [1452185189, {"cpu_p"=>7.00, "user_p"=>5.00, "system_p"=>2.00, "cpu0.p_cpu"=>10.00, "cpu0.p_user"=>8.00, "cpu0.p_system"=>2.00, "cpu1.p_cpu"=>6.00, "cpu1.p_user"=>4.00, "cpu1.p_system"=>2.00}]
 [1] [1452185190, {"cpu_p"=>6.50, "user_p"=>5.00, "system_p"=>1.50, "cpu0.p_cpu"=>6.00, "cpu0.p_user"=>5.00, "cpu0.p_system"=>1.00, "cpu1.p_cpu"=>7.00, "cpu1.p_user"=>5.00, "cpu1.p_system"=>2.00}]
 [2] [1452185191, {"cpu_p"=>7.50, "user_p"=>5.00, "system_p"=>2.50, "cpu0.p_cpu"=>7.00, "cpu0.p_user"=>3.00, "cpu0.p_system"=>4.00, "cpu1.p_cpu"=>6.00, "cpu1.p_user"=>6.00, "cpu1.p_system"=>0.00}]
 [3] [1452185192, {"cpu_p"=>4.50, "user_p"=>3.50, "system_p"=>1.00, "cpu0.p_cpu"=>6.00, "cpu0.p_user"=>5.00, "cpu0.p_system"=>1.00, "cpu1.p_cpu"=>5.00, "cpu1.p_user"=>3.00, "cpu1.p_system"=>2.00}]
+...
 ```
 
 As described previously, the CPU input plugin gathers the overall usage every one second and flushed the information to the output on the fifth second. This example uses the `stdout` plugin to demonstrate the output records. In a real use-case you might want to flush this information to some central aggregator such as [Fluentd](http://fluentd.org) or [Elasticsearch](http://elastic.co).
@@ -71,26 +66,26 @@ In your main configuration file append the following:
 ```yaml
 
 pipeline:
-    inputs:
-        - name: cpu
-          tag: my_cpu
+  inputs:
+    - name: cpu
+      tag: my_cpu
 
-    outputs:
-        - name: stdout
-          match: '*'
+  outputs:
+    - name: stdout
+      match: '*'
 ```
 
 {% endtab %}
 {% tab title="fluent-bit.conf" %}
 
 ```shell
 [INPUT]
-    Name cpu
-    Tag  my_cpu
+  Name cpu
+  Tag  my_cpu
 
 [OUTPUT]
-    Name  stdout
-    Match *
+  Name  stdout
+  Match *
 ```
 
 {% endtab %}

pipeline/inputs/disk-io-metrics.md

@@ -8,12 +8,12 @@ The _Disk I/O metrics_ plugin creates metrics that are log-based, such as JSON p
 
 The plugin supports the following configuration parameters:
 
-| Key | Description | Default |
-| :--- | :--- | :--- |
-| `Interval_Sec` | Polling interval (seconds).  | `1` |
-| `Interval_NSec` | Polling interval (nanosecond). | `0` |
-| `Dev_Name` | Device name to limit the target (for example, `sda`). If not set, `in_disk` gathers information from all of disks and partitions. | all disks |
-| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
+| Key             | Description                                                                                                                       | Default   |
+|:----------------|:----------------------------------------------------------------------------------------------------------------------------------|:----------|
+| `Interval_Sec`  | Polling interval (seconds).                                                                                                       | `1`       |
+| `Interval_NSec` | Polling interval (nanosecond).                                                                                                    | `0`       |
+| `Dev_Name`      | Device name to limit the target (for example, `sda`). If not set, `in_disk` gathers information from all of disks and partitions. | all disks |
+| `Threaded`      | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs).                           | `false`   |
 
 ## Get started
 
@@ -30,17 +30,12 @@ fluent-bit -i disk -o stdout
 Which returns information like the following:
 
 ```text
-Fluent Bit v1.x.x
-* Copyright (C) 2019-2020 The Fluent Bit Authors
-* Copyright (C) 2015-2018 Treasure Data
-* Fluent Bit is a CNCF sub-project under the umbrella of Fluentd
-* https://fluentbit.io
-
-[2017/01/28 16:58:16] [ info] [engine] started
+...
 [0] disk.0: [1485590297, {"read_size"=>0, "write_size"=>0}]
 [1] disk.0: [1485590298, {"read_size"=>0, "write_size"=>0}]
 [2] disk.0: [1485590299, {"read_size"=>0, "write_size"=>0}]
 [3] disk.0: [1485590300, {"read_size"=>0, "write_size"=>11997184}]
+...
 ```
 
 ### Configuration file
@@ -52,30 +47,30 @@ In your main configuration file append the following:
 
 ```yaml
 pipeline:
-    inputs:
-        - name: disk
-          tag: disk
-          interval_sec: 1
-          interval_nsec: 0
-
-    outputs:
-        - name: stdout
-          match: '*'
+  inputs:
+    - name: disk
+      tag: disk
+      interval_sec: 1
+      interval_nsec: 0
+
+  outputs:
+    - name: stdout
+      match: '*'
 ```
 
 {% endtab %}
 {% tab title="fluent-bit.conf" %}
 
 ```text
 [INPUT]
-    Name          disk
-    Tag           disk
-    Interval_Sec  1
-    Interval_NSec 0
+  Name          disk
+  Tag           disk
+  Interval_Sec  1
+  Interval_NSec 0
 
 [OUTPUT]
-    Name   stdout
-    Match  *
+  Name   stdout
+  Match  *
 ```
 
 {% endtab %}

pipeline/inputs/docker-events.md

@@ -6,15 +6,15 @@ The _Docker events_ input plugin uses the Docker API to capture server events. A
 
 This plugin supports the following configuration parameters:
 
-| Key | Description | Default |
-| :--- | :--- | :--- |
-| `Unix_Path` | The docker socket Unix path. | `/var/run/docker.sock` |
-| `Buffer_Size` | The size of the buffer used to read docker events in bytes. | `8192` |
-| `Parser` | Specify the name of a parser to interpret the entry as a structured message. | _none_ |
-| `Key` | When a message is unstructured (no parser applied), it's appended as a string under the key name `message`. | `message` |
-| `Reconnect.Retry_limits`| The maximum number of retries allowed. The plugin tries to reconnect with docker socket when `EOF` is detected. | `5` |
-| `Reconnect.Retry_interval`| The retry interval in seconds. | `1` |
-| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
+| Key                        | Description                                                                                                     | Default                |
+|:---------------------------|:----------------------------------------------------------------------------------------------------------------|:-----------------------|
+| `Unix_Path`                | The docker socket Unix path.                                                                                    | `/var/run/docker.sock` |
+| `Buffer_Size`              | The size of the buffer used to read docker events in bytes.                                                     | `8192`                 |
+| `Parser`                   | Specify the name of a parser to interpret the entry as a structured message.                                    | _none_                 |
+| `Key`                      | When a message is unstructured (no parser applied), it's appended as a string under the key name `message`.     | `message`              |
+| `Reconnect.Retry_limits`   | The maximum number of retries allowed. The plugin tries to reconnect with docker socket when `EOF` is detected. | `5`                    |
+| `Reconnect.Retry_interval` | The retry interval in seconds.                                                                                  | `1`                    |
+| `Threaded`                 | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs).         | `false`                |
 
 ### Command line
 
@@ -33,24 +33,24 @@ In your main configuration file append the following:
 
 ```yaml
 pipeline:
-    inputs:
-        - name: docker_events
+  inputs:
+    - name: docker_events
 
-    outputs:
-        - name: stdout
-          match: '*'
+  outputs:
+    - name: stdout
+      match: '*'
 ```
 
 {% endtab %}
 {% tab title="fluent-bit.conf" %}
 
 ```text
 [INPUT]
-    Name   docker_events
+  Name   docker_events
 
 [OUTPUT]
-    Name   stdout
-    Match  *
+  Name   stdout
+  Match  *
 ```
 
 {% endtab %}

pipeline/inputs/docker-metrics.md

@@ -6,13 +6,13 @@ The _Docker_ input plugin you collect Docker container metrics, including memory
 
 The plugin supports the following configuration parameters:
 
-| Key          | Description                                     | Default |
-| ------------ | ----------------------------------------------- | ------- |
-| `Interval_Sec` | Polling interval in seconds                     | `1`   |
-| `Include`      | A space-separated list of containers to include. | _none_ |
-| `Exclude`      | A space-separated list of containers to exclude. | _none_ |
-| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
-| `path.containers` | Used to specify the container directory if Docker is configured with a custom `data-root` directory. | `/var/lib/docker/containers` |
+| Key               | Description                                                                                             | Default                      |
+|-------------------|---------------------------------------------------------------------------------------------------------|------------------------------|
+| `Interval_Sec`    | Polling interval in seconds                                                                             | `1`                          |
+| `Include`         | A space-separated list of containers to include.                                                        | _none_                       |
+| `Exclude`         | A space-separated list of containers to exclude.                                                        | _none_                       |
+| `Threaded`        | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false`                      |
+| `path.containers` | Used to specify the container directory if Docker is configured with a custom `data-root` directory.    | `/var/lib/docker/containers` |
 
 If you set neither `Include` nor `Exclude`, the plugin will try to get metrics from all running containers.
 
@@ -25,25 +25,26 @@ The following example configuration collects metrics from two docker instances (
 
 ```yaml
 pipeline:
-    inputs:
-        - name: docker
-          include: 6bab19c3a0f9 14159be4ca2c
+  inputs:
+    - name: docker
+      include: 6bab19c3a0f9 14159be4ca2c
 
-    outputs:
-        - name: stdout
-          match: '*'
+  outputs:
+    - name: stdout
+      match: '*'
 ```
 
 {% endtab %}
 {% tab title="fluent-bit.conf" %}
 
 ```text
 [INPUT]
-    Name         docker
-    Include      6bab19c3a0f9 14159be4ca2c
+  Name         docker
+  Include      6bab19c3a0f9 14159be4ca2c
+
 [OUTPUT]
-    Name   stdout
-    Match  *
+  Name   stdout
+  Match  *
 ```
 
 {% endtab %}