Skip to content
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.

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

nat output module doc update #1416

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
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
7 changes: 7 additions & 0 deletions pipeline/outputs/nats.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ In order to override the default configuration values, the plugin uses the optio
nats://host:port
```

The stream name (like a Kafka _topic_) is based on the event_check->tag.

## Running

[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.
Expand Down Expand Up @@ -65,3 +67,8 @@ Each record is an individual entity represented in a JSON array that contains a
]
```

{% hint style="info" %}
**Note:** This module
[writes to the NATS stream as JSON ](https://github.com/fluent/fluent-bit/blob/master/plugins/out_nats/nats.c#L185C1-L189C49),
rather than MsgPack (`msgpack_to_json`).
{% endhint %}