From bd571bd8f029c68a4fa7a3d7bc4ebcadfc810c9d Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla Date: Sun, 13 Oct 2024 15:56:11 -0500 Subject: [PATCH 01/20] adding openobserve details for fluentbit output Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 44 +++++++++++++++++++++++++++++++++ 1 file changed, 44 insertions(+) create mode 100644 pipeline/outputs/openobserve.md diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md new file mode 100644 index 000000000..9b39ed86f --- /dev/null +++ b/pipeline/outputs/openobserve.md @@ -0,0 +1,44 @@ +--- +description: Send logs to OpenObserve using Fluent Bit +--- + +# OpenObserve + +The OpenObserve output plugin allows to ingest your logs into [OpenObserve](https://openobserve.ai/). + +Before you begin, you need a [OpenObserve account](https://cloud.openobserve.ai/), a HTTP_User and HTTP_Passwd that will be available under Ingestion of your O2 platform. Alternatively, you can achieve this with various installation types as mentioned in this [documentation](https://openobserve.ai/docs/quickstart/) + +## Configuration Parameters + +| Key | Description | Default | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | +| Host | _Required_ - The OpenObserve server where you are sending your logs. | `localhost` | +| TLS | _Required_ - Enable end-to-end security using TLS. Set to `on` to enable TLS communication with OpenObserve. | `on` | +| compress | _Recommended_ - Compresses the payload in GZIP format. OpenObserve supports and recommends setting this to `gzip` for optimized log ingestion. | | +| HTTP_User | _Required_ - Username for HTTP authentication. | | +| HTTP_Passwd | _Required_ - Password for HTTP authentication. | | +| URI | _Required_ - The API path where the logs will be sent. | `/api/default/default/_json` | +| Format | _Required_ - The format of the log payload. OpenObserve expects json. | `json` | +| json_date_key | _Optional_ The JSON key used for timestamps in the logs. | `timestamp` | +| json_date_format | _Optional_ The format of the date in logs. OpenObserve supports iso8601. | `iso8601` | +| include_tag_key | If enabled, a tag is appended to output. The key name is used `tag_key` property. | `false` | + +### Configuration File + +Get started quickly with this configuration file: + +``` +[OUTPUT] + Name http + Match * + URI /api/default/default/_json + Host localhost + Port 5080 + tls Off + Format json + Json_date_key _timestamp + Json_date_format iso8601 + HTTP_User + HTTP_Passwd + compress gzip +``` \ No newline at end of file From e8ec3f55f464970b7d6b32471efd6ea69427d85c Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:07:46 -0500 Subject: [PATCH 02/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 1 + 1 file changed, 1 insertion(+) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 9b39ed86f..73fc41e27 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -1,4 +1,5 @@ --- +title: OpenObserve description: Send logs to OpenObserve using Fluent Bit --- From 380a4d922fdc6e80cfa287f42bc04302fe8e5ed1 Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:07:54 -0500 Subject: [PATCH 03/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 73fc41e27..97ba9fda9 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -5,7 +5,7 @@ description: Send logs to OpenObserve using Fluent Bit # OpenObserve -The OpenObserve output plugin allows to ingest your logs into [OpenObserve](https://openobserve.ai/). +Use the OpenObserve output plugin to ingest logs into [OpenObserve](https://openobserve.ai/). Before you begin, you need a [OpenObserve account](https://cloud.openobserve.ai/), a HTTP_User and HTTP_Passwd that will be available under Ingestion of your O2 platform. Alternatively, you can achieve this with various installation types as mentioned in this [documentation](https://openobserve.ai/docs/quickstart/) From c363f33ce694fabc2572ba2d0c39858c1428c6ae Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:08:05 -0500 Subject: [PATCH 04/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 97ba9fda9..c4c5bfa9d 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -7,7 +7,11 @@ description: Send logs to OpenObserve using Fluent Bit Use the OpenObserve output plugin to ingest logs into [OpenObserve](https://openobserve.ai/). -Before you begin, you need a [OpenObserve account](https://cloud.openobserve.ai/), a HTTP_User and HTTP_Passwd that will be available under Ingestion of your O2 platform. Alternatively, you can achieve this with various installation types as mentioned in this [documentation](https://openobserve.ai/docs/quickstart/) +Before you begin, you need an [OpenObserve account](https://cloud.openobserve.ai/), an +`HTTP_User`, and an `HTTP_Passwd`. You can find these fields under **Ingestion** in +OpenObserve Cloud. Alternatively, you can achieve this with various installation +types as mentioned in the +[OpenObserve documentation](https://openobserve.ai/docs/quickstart/) ## Configuration Parameters From 1c8a5d2d26820cfaa0a398462ed84f8be3d9310b Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:08:14 -0500 Subject: [PATCH 05/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index c4c5bfa9d..c028a8454 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -17,7 +17,7 @@ types as mentioned in the | Key | Description | Default | | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | -| Host | _Required_ - The OpenObserve server where you are sending your logs. | `localhost` | +| Host | Required. The OpenObserve server where you are sending logs. | `localhost` | | TLS | _Required_ - Enable end-to-end security using TLS. Set to `on` to enable TLS communication with OpenObserve. | `on` | | compress | _Recommended_ - Compresses the payload in GZIP format. OpenObserve supports and recommends setting this to `gzip` for optimized log ingestion. | | | HTTP_User | _Required_ - Username for HTTP authentication. | | From dc692c93d0cda7c07f7de517bc6f50df049eac1a Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:08:20 -0500 Subject: [PATCH 06/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index c028a8454..877dc2cca 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -18,7 +18,7 @@ types as mentioned in the | Key | Description | Default | | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | Host | Required. The OpenObserve server where you are sending logs. | `localhost` | -| TLS | _Required_ - Enable end-to-end security using TLS. Set to `on` to enable TLS communication with OpenObserve. | `on` | +| TLS | Required: Enable end-to-end security using TLS. Set to `on` to enable TLS communication with OpenObserve. | `on` | | compress | _Recommended_ - Compresses the payload in GZIP format. OpenObserve supports and recommends setting this to `gzip` for optimized log ingestion. | | | HTTP_User | _Required_ - Username for HTTP authentication. | | | HTTP_Passwd | _Required_ - Password for HTTP authentication. | | From 537c52dd1de5909fbdd854bd0c1ef15825b05cec Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:08:26 -0500 Subject: [PATCH 07/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 877dc2cca..0ab993f0e 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -30,7 +30,7 @@ types as mentioned in the ### Configuration File -Get started quickly with this configuration file: +Use this configuration file to get started: ``` [OUTPUT] From e0303e2b9d194e103dc571f7d57c6a69dcb0da0b Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:08:33 -0500 Subject: [PATCH 08/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 0ab993f0e..74dbaaa56 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -41,7 +41,7 @@ Use this configuration file to get started: Port 5080 tls Off Format json - Json_date_key _timestamp + Json_date_key timestamp Json_date_format iso8601 HTTP_User HTTP_Passwd From ee7e0662a0354f84730b1a7174a07edbefba56e0 Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:08:39 -0500 Subject: [PATCH 09/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 74dbaaa56..54c18549f 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -43,7 +43,7 @@ Use this configuration file to get started: Format json Json_date_key timestamp Json_date_format iso8601 - HTTP_User + HTTP_User HTTP_Passwd compress gzip ``` \ No newline at end of file From 087e778b5fd71470342a1d844b7ab4ed49d932ac Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:08:46 -0500 Subject: [PATCH 10/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 54c18549f..41828a6dd 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -44,6 +44,6 @@ Use this configuration file to get started: Json_date_key timestamp Json_date_format iso8601 HTTP_User - HTTP_Passwd + HTTP_Passwd compress gzip ``` \ No newline at end of file From 53f50ce8d7ca86f8190b14315540cc71e87365f8 Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:09:03 -0500 Subject: [PATCH 11/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 41828a6dd..21663d382 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -39,7 +39,7 @@ Use this configuration file to get started: URI /api/default/default/_json Host localhost Port 5080 - tls Off + tls on Format json Json_date_key timestamp Json_date_format iso8601 From 92f6805da7b427e2a85e949207d63852c19bd55e Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:10:17 -0500 Subject: [PATCH 12/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 21663d382..d8957d140 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -19,7 +19,7 @@ types as mentioned in the | --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | | Host | Required. The OpenObserve server where you are sending logs. | `localhost` | | TLS | Required: Enable end-to-end security using TLS. Set to `on` to enable TLS communication with OpenObserve. | `on` | -| compress | _Recommended_ - Compresses the payload in GZIP format. OpenObserve supports and recommends setting this to `gzip` for optimized log ingestion. | | +| compress | Recommended: Compresses the payload in GZIP format. OpenObserve supports and recommends setting this to `gzip` for optimized log ingestion. | _none_ | | HTTP_User | _Required_ - Username for HTTP authentication. | | | HTTP_Passwd | _Required_ - Password for HTTP authentication. | | | URI | _Required_ - The API path where the logs will be sent. | `/api/default/default/_json` | From 972eb496186a9e56e7960da3c9102291cc01ed6a Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:10:26 -0500 Subject: [PATCH 13/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index d8957d140..7333445a2 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -21,7 +21,7 @@ types as mentioned in the | TLS | Required: Enable end-to-end security using TLS. Set to `on` to enable TLS communication with OpenObserve. | `on` | | compress | Recommended: Compresses the payload in GZIP format. OpenObserve supports and recommends setting this to `gzip` for optimized log ingestion. | _none_ | | HTTP_User | _Required_ - Username for HTTP authentication. | | -| HTTP_Passwd | _Required_ - Password for HTTP authentication. | | +| HTTP_Passwd | Required: Password for HTTP authentication. | _none_ | | URI | _Required_ - The API path where the logs will be sent. | `/api/default/default/_json` | | Format | _Required_ - The format of the log payload. OpenObserve expects json. | `json` | | json_date_key | _Optional_ The JSON key used for timestamps in the logs. | `timestamp` | From 336b0a284352f0dd41b015d64d4c41f729fdfcb8 Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:10:35 -0500 Subject: [PATCH 14/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 7333445a2..6a48ce174 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -22,7 +22,7 @@ types as mentioned in the | compress | Recommended: Compresses the payload in GZIP format. OpenObserve supports and recommends setting this to `gzip` for optimized log ingestion. | _none_ | | HTTP_User | _Required_ - Username for HTTP authentication. | | | HTTP_Passwd | Required: Password for HTTP authentication. | _none_ | -| URI | _Required_ - The API path where the logs will be sent. | `/api/default/default/_json` | +| URI | Required: The API path used to send logs. | `/api/default/default/_json` | | Format | _Required_ - The format of the log payload. OpenObserve expects json. | `json` | | json_date_key | _Optional_ The JSON key used for timestamps in the logs. | `timestamp` | | json_date_format | _Optional_ The format of the date in logs. OpenObserve supports iso8601. | `iso8601` | From 854a7ae1ea2ae421ff3ed6a50850bf72c764fecb Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:10:41 -0500 Subject: [PATCH 15/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 6a48ce174..b10468bd5 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -24,7 +24,7 @@ types as mentioned in the | HTTP_Passwd | Required: Password for HTTP authentication. | _none_ | | URI | Required: The API path used to send logs. | `/api/default/default/_json` | | Format | _Required_ - The format of the log payload. OpenObserve expects json. | `json` | -| json_date_key | _Optional_ The JSON key used for timestamps in the logs. | `timestamp` | +| json_date_key | Optional: The JSON key used for timestamps in the logs. | `timestamp` | | json_date_format | _Optional_ The format of the date in logs. OpenObserve supports iso8601. | `iso8601` | | include_tag_key | If enabled, a tag is appended to output. The key name is used `tag_key` property. | `false` | From 9fce415a4e0eb2690499cc74a2e9a333dc478efd Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:10:49 -0500 Subject: [PATCH 16/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index b10468bd5..d21b08ba0 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -20,7 +20,7 @@ types as mentioned in the | Host | Required. The OpenObserve server where you are sending logs. | `localhost` | | TLS | Required: Enable end-to-end security using TLS. Set to `on` to enable TLS communication with OpenObserve. | `on` | | compress | Recommended: Compresses the payload in GZIP format. OpenObserve supports and recommends setting this to `gzip` for optimized log ingestion. | _none_ | -| HTTP_User | _Required_ - Username for HTTP authentication. | | +| HTTP_User | Required: Username for HTTP authentication. | _none_ | | HTTP_Passwd | Required: Password for HTTP authentication. | _none_ | | URI | Required: The API path used to send logs. | `/api/default/default/_json` | | Format | _Required_ - The format of the log payload. OpenObserve expects json. | `json` | From 4d4ca4a5e89314d954a15faa725ba52789cf2711 Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:10:55 -0500 Subject: [PATCH 17/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index d21b08ba0..a54fe5f98 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -23,7 +23,7 @@ types as mentioned in the | HTTP_User | Required: Username for HTTP authentication. | _none_ | | HTTP_Passwd | Required: Password for HTTP authentication. | _none_ | | URI | Required: The API path used to send logs. | `/api/default/default/_json` | -| Format | _Required_ - The format of the log payload. OpenObserve expects json. | `json` | +| Format | Required: The format of the log payload. OpenObserve expects JSON. | `json` | | json_date_key | Optional: The JSON key used for timestamps in the logs. | `timestamp` | | json_date_format | _Optional_ The format of the date in logs. OpenObserve supports iso8601. | `iso8601` | | include_tag_key | If enabled, a tag is appended to output. The key name is used `tag_key` property. | `false` | From 5366d427c4fd8cd8f0349e48dddfb2fc4af1f087 Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:11:00 -0500 Subject: [PATCH 18/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index a54fe5f98..44011527e 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -26,7 +26,7 @@ types as mentioned in the | Format | Required: The format of the log payload. OpenObserve expects JSON. | `json` | | json_date_key | Optional: The JSON key used for timestamps in the logs. | `timestamp` | | json_date_format | _Optional_ The format of the date in logs. OpenObserve supports iso8601. | `iso8601` | -| include_tag_key | If enabled, a tag is appended to output. The key name is used `tag_key` property. | `false` | +| include_tag_key | If `true`, a tag is appended to the output. The key name is used in the `tag_key` property. | `false` | ### Configuration File From db52e532fef38734e05fd1f783fe7f18aa19ecce Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:11:08 -0500 Subject: [PATCH 19/20] Update pipeline/outputs/openobserve.md Co-authored-by: Adam Locke Signed-off-by: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Signed-off-by: Chaitanya Sistla --- pipeline/outputs/openobserve.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 44011527e..94a10c91a 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -25,7 +25,7 @@ types as mentioned in the | URI | Required: The API path used to send logs. | `/api/default/default/_json` | | Format | Required: The format of the log payload. OpenObserve expects JSON. | `json` | | json_date_key | Optional: The JSON key used for timestamps in the logs. | `timestamp` | -| json_date_format | _Optional_ The format of the date in logs. OpenObserve supports iso8601. | `iso8601` | +| json_date_format | Optional: The format of the date in logs. OpenObserve supports ISO 8601. | `iso8601` | | include_tag_key | If `true`, a tag is appended to the output. The key name is used in the `tag_key` property. | `false` | ### Configuration File From 16de651c3397d98896571bdd328cf18568a32c3f Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla Date: Mon, 14 Oct 2024 09:59:58 -0500 Subject: [PATCH 20/20] adding openobserve in summary Signed-off-by: Chaitanya Sistla --- SUMMARY.md | 1 + 1 file changed, 1 insertion(+) diff --git a/SUMMARY.md b/SUMMARY.md index 71752e5e2..7fb7ac0d5 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -187,6 +187,7 @@ * [NATS](pipeline/outputs/nats.md) * [New Relic](pipeline/outputs/new-relic.md) * [NULL](pipeline/outputs/null.md) + * [OpenObserve](pipeline/inputs/openobserve.md) * [Observe](pipeline/outputs/observe.md) * [Oracle Log Analytics](pipeline/outputs/oci-logging-analytics.md) * [OpenSearch](pipeline/outputs/opensearch.md)