Skip to content

Commit 466c162

Browse files
Merge pull request #1976 from fluent/alexakreizinger/sc-136250/update-fluent-bit-docs-pipeline-outputs-nats
2 parents 8c49680 + 4f0a162 commit 466c162

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

pipeline/outputs/nats.md

Lines changed: 15 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
# NATS
22

3-
The **nats** output plugin, allows to flush your records into a [NATS Server](https://docs.nats.io/nats-concepts/intro) end point. The following instructions assumes that you have a fully operational NATS Server in place.
3+
The _NATS_ output plugin lets you flush your records into a [NATS Server](https://docs.nats.io/) server endpoint.
44

55
## Configuration parameters
66

7-
| parameter | description | default |
8-
|:----------|:---------------------------------------------------------------------------------------------------------------------|:----------|
9-
| host | IP address or hostname of the NATS Server | 127.0.0.1 |
10-
| port | TCP port of the target NATS Server | 4222 |
11-
| workers | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
7+
| Key | Description | Default |
8+
| --- | ----------- | ------- |
9+
| `host` | The IP address or hostname of the NATS server. | `127.0.0.1` |
10+
| `port` | The TCP port of the target NATS server. | `4222` |
11+
| `workers` | The number of [workers](../administration/multithreading.md#outputs) to perform flush operations for this output. | `0` |
1212

13-
In order to override the default configuration values, the plugin uses the optional Fluent Bit network address format, e.g:
13+
{% hint style="info" %}
1414

15-
```text
16-
nats://host:port
17-
```
15+
To override the default configuration values, this plugin uses the optional Fluent Bit network address format (for example, `nats://host:port`).
16+
17+
{% endhint %}
1818

19-
## Running
19+
## Get started
2020

21-
[Fluent Bit](http://fluentbit.io) only requires to know that it needs to use the **nats** output plugin, if no extra information is given, it will use the default values specified in the above table.
21+
You can get started with the NATS output plugin through the command line. If you use the following command without specifying parameter values, Fluent Bit uses the default values defined in the previous section.
2222

2323
```shell
2424
$ fluent-bit -i cpu -o nats -V -f 5
@@ -38,11 +38,9 @@ cpu[i=3] all=6.000000 user=5.000000 system=1.000000
3838
...
3939
```
4040

41-
As described above, the target service and storage point can be changed, e.g:
42-
4341
## Data format
4442

45-
For every set of records flushed to a NATS Server, Fluent Bit uses the following format:
43+
For every set of records flushed to a NATS server, Fluent Bit uses the following format:
4644

4745
```text
4846
[
@@ -52,12 +50,12 @@ For every set of records flushed to a NATS Server, Fluent Bit uses the following
5250
]
5351
```
5452

55-
Each record is an individual entity represented in a JSON array that contains a UNIX\_TIMESTAMP and a JSON map with a set of key/values. A summarized output of the CPU input plugin will look as this:
53+
Each record is an individual entity represented in a JSON array that contains a Unix timestamp and a JSON map with a set of key/value pairs. A summarized output of the CPU input plugin will resemble the following:
5654

5755
```json
5856
[
5957
[1457108504,{"tag":"fluentbit","cpu_p":1.500000,"user_p":1,"system_p":0.500000}],
6058
[1457108505,{"tag":"fluentbit","cpu_p":4.500000,"user_p":3,"system_p":1.500000}],
6159
[1457108506,{"tag":"fluentbit","cpu_p":6.500000,"user_p":4.500000,"system_p":2}]
6260
]
63-
```
61+
```

vale-styles/FluentBit/Acronyms.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,7 @@ exceptions:
6868
- MAC
6969
- MQTT
7070
- MSK
71+
- NATS
7172
- NET
7273
- NGINX
7374
- NIC

vale-styles/FluentBit/Headings.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ exceptions:
7575
- macOS
7676
- Marketplace
7777
- MongoDB
78+
- NATS
7879
- New Relic
7980
- Observability Platform
8081
- Okta

0 commit comments

Comments
 (0)