Merge pull request #1754 from fluent/lynettemiles/sc-136187/update-fluent-bit-docs-pipeline-inputs-network

Author: esmerel

pipeline/inputs/network-io-metrics.md

@@ -1,31 +1,37 @@
-# Network I/O Metrics
+# Network I/O metrics
 
-The **netif** input plugin gathers network traffic information of the running system every certain interval of time, and reports them.
+The _Network I/O metrics_ (`netif`) input plugin gathers network traffic information of the running system at regular intervals, and reports them.
 
-The Network I/O Metrics plugin creates metrics that are log-based, such as JSON
-payload. For Prometheus-based metrics, see the Node Exporter Metrics input plugin.
+The Network I/O metrics plugin creates metrics that are log-based, such as JSON payload. For Prometheus-based metrics, see the Node Exporter metrics input plugin.
 
-## Configuration Parameters
+## Configuration parameters
 
 The plugin supports the following configuration parameters:
 
 | Key | Description | Default |
 | :--- | :--- | :--- |
-| Interface | Specify the network interface to monitor. e.g. eth0 | |
-| Interval\_Sec | Polling interval \(seconds\). | 1 |
-| Interval\_NSec | Polling interval \(nanosecond\). | 0 |
-| Verbose | If true, gather metrics precisely. | false |
-| Test\_At\_Init | If true, testing if the network interface is valid at initialization. | false |
-| Threaded | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
+| `Interface` | Specify the network interface to monitor. For example, `eth0`. | _none_ |
+| `Interval_Sec` | Polling interval (seconds). | `1` |
+| `Interval_NSec` | Polling interval (nanosecond). | `0` |
+| `Verbose` | If true, gather metrics precisely. | `false` |
+| `Test_At_Init` | If true, testing if the network interface is valid at initialization. | `false` |
+| `Threaded` | Indicates whether to run this input in its own [thread](../../administration/multithreading.md#inputs). | `false` |
 
-## Getting Started
+## Get started
 
-In order to monitor network traffic from your system, you can run the plugin from the command line or through the configuration file:
+To monitor network traffic from your system, you can run the plugin from the command line or through the configuration file:
 
-### Command Line
+### Command line
+
+Run Fluent Bit using a command similar to the following:
 
 ```bash
-$ bin/fluent-bit -i netif -p interface=eth0 -o stdout
+bin/fluent-bit -i netif -p interface=eth0 -o stdout
+```
+
+Which returns something the following:
+
+```text
 Fluent Bit v1.x.x
 * Copyright (C) 2019-2020 The Fluent Bit Authors
 * Copyright (C) 2015-2018 Treasure Data
@@ -39,12 +45,13 @@ Fluent Bit v1.x.x
 [3] netif.0: [1499524462.002612971, {"eth0.rx.bytes"=>98, "eth0.rx.packets"=>1, "eth0.rx.errors"=>0, "eth0.tx.bytes"=>98, "eth0.tx.packets"=>1, "eth0.tx.errors"=>0}]
 ```
 
-### Configuration File
+### Configuration file
 
-In your main configuration file append the following _Input_ & _Output_ sections:
+In your main configuration file append the following `Input` and `Output` sections:
 
 {% tabs %}
 {% tab title="fluent-bit.conf" %}
+
 ```python
 [INPUT]
     Name          netif
@@ -56,9 +63,11 @@ In your main configuration file append the following _Input_ & _Output_ sections
     Name   stdout
     Match  *
 ```
+
 {% endtab %}
 
 {% tab title="fluent-bit.yaml" %}
+
 ```yaml
 pipeline:
     inputs:
@@ -71,9 +80,10 @@ pipeline:
         - name: stdout
           match: '*'
 ```
+
 {% endtab %}
 {% endtabs %}
 
-Note: Total interval \(sec\) = Interval\_Sec + \(Interval\_Nsec / 1000000000\).
+Which calculates using the formula: `Total interval (sec) = Interval_Sec + (Interval_Nsec / 1000000000)`.
 
-e.g. 1.5s = 1s + 500000000ns
+For example: `1.5s = 1s + 500000000ns`