From fbfc9fb92adb6204918da122f0eb13f48722f89a Mon Sep 17 00:00:00 2001 From: randomizedcoder Date: Tue, 30 Jul 2024 12:59:53 -0700 Subject: [PATCH 1/6] nat output module doc update --- pipeline/outputs/nats.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/pipeline/outputs/nats.md b/pipeline/outputs/nats.md index c2586e45a..485ae7657 100644 --- a/pipeline/outputs/nats.md +++ b/pipeline/outputs/nats.md @@ -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. @@ -65,3 +67,7 @@ Each record is an individual entity represented in a JSON array that contains a ] ``` +Please note that this module writes to the NATS stream as JSON, rather than MsgPack ( msgpack_to_json ). + + +See also: https://github.com/fluent/fluent-bit/blob/master/plugins/out_nats/nats.c#L185C1-L189C49 \ No newline at end of file From 610895375ff7ee62bda6ca84ad4acd79e2c7826f Mon Sep 17 00:00:00 2001 From: randomizedcoder <64496590+randomizedcoder@users.noreply.github.com> Date: Tue, 30 Jul 2024 13:53:17 -0700 Subject: [PATCH 2/6] Update pipeline/outputs/nats.md Co-authored-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> Signed-off-by: randomizedcoder <64496590+randomizedcoder@users.noreply.github.com> --- pipeline/outputs/nats.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/nats.md b/pipeline/outputs/nats.md index 485ae7657..0c6f1ade9 100644 --- a/pipeline/outputs/nats.md +++ b/pipeline/outputs/nats.md @@ -15,7 +15,7 @@ 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. +The stream name (like a Kafka _topic_) is based on the event_check->tag. ## Running From b5ba633389989f9527cb68932d731ad8fead2c44 Mon Sep 17 00:00:00 2001 From: randomizedcoder <64496590+randomizedcoder@users.noreply.github.com> Date: Tue, 30 Jul 2024 13:53:22 -0700 Subject: [PATCH 3/6] Update pipeline/outputs/nats.md Co-authored-by: Craig Norris <112565517+cnorris-cs@users.noreply.github.com> Signed-off-by: randomizedcoder <64496590+randomizedcoder@users.noreply.github.com> --- pipeline/outputs/nats.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/pipeline/outputs/nats.md b/pipeline/outputs/nats.md index 0c6f1ade9..310dffb21 100644 --- a/pipeline/outputs/nats.md +++ b/pipeline/outputs/nats.md @@ -67,7 +67,8 @@ Each record is an individual entity represented in a JSON array that contains a ] ``` -Please note that this module writes to the NATS stream as JSON, rather than MsgPack ( msgpack_to_json ). - - -See also: https://github.com/fluent/fluent-bit/blob/master/plugins/out_nats/nats.c#L185C1-L189C49 \ No newline at end of file +{% 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 %} \ No newline at end of file From 6c55a085a4223e666df1ac4e9d93684a9f319522 Mon Sep 17 00:00:00 2001 From: randomizedcoder Date: Wed, 31 Jul 2024 14:49:48 -0700 Subject: [PATCH 4/6] Signed-off-by: Dave Seddon --- pipeline/outputs/nats.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/nats.md b/pipeline/outputs/nats.md index 310dffb21..810782678 100644 --- a/pipeline/outputs/nats.md +++ b/pipeline/outputs/nats.md @@ -69,6 +69,6 @@ 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), +[ 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 %} \ No newline at end of file From a204aded36d0f24c4bae12e08e386b3cb575fe28 Mon Sep 17 00:00:00 2001 From: randomizedcoder Date: Wed, 31 Jul 2024 14:52:01 -0700 Subject: [PATCH 5/6] Small NATS output documentation enhancement Signed-off-by: randomizedcoder --- pipeline/outputs/nats.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/nats.md b/pipeline/outputs/nats.md index 810782678..310dffb21 100644 --- a/pipeline/outputs/nats.md +++ b/pipeline/outputs/nats.md @@ -69,6 +69,6 @@ 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), +[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 %} \ No newline at end of file From 3885422ae9cd1458f7599499b31beab9301c3275 Mon Sep 17 00:00:00 2001 From: randomizedcoder Date: Wed, 31 Jul 2024 14:53:19 -0700 Subject: [PATCH 6/6] Signed-off-by: randomizedcoder dave.seddon.ca@gmail.com --- pipeline/outputs/nats.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/nats.md b/pipeline/outputs/nats.md index 310dffb21..39f6b3ae7 100644 --- a/pipeline/outputs/nats.md +++ b/pipeline/outputs/nats.md @@ -69,6 +69,6 @@ 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), +[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 %} \ No newline at end of file