From 5fecb6532b34f4589f058298fa0be9c2ec675cb8 Mon Sep 17 00:00:00 2001 From: Chaitanya Sistla <122406662+chaitanya-sistla@users.noreply.github.com> Date: Tue, 15 Oct 2024 11:36:08 -0500 Subject: [PATCH] adding openobserve for 3.1 (#1473) Signed-off-by: Chaitanya Sistla <chaitanyasistla@Chaitanyas-MBP.attlocal.net> Co-authored-by: Chaitanya Sistla <chaitanyasistla@Chaitanyas-MBP.attlocal.net> --- SUMMARY.md | 1 + pipeline/outputs/openobserve.md | 49 +++++++++++++++++++++++++++++++++ 2 files changed, 50 insertions(+) create mode 100644 pipeline/outputs/openobserve.md diff --git a/SUMMARY.md b/SUMMARY.md index 34c681c26..e125658a8 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/outputs/openobserve.md) * [Observe](pipeline/outputs/observe.md) * [Oracle Log Analytics](pipeline/outputs/oci-logging-analytics.md) * [OpenSearch](pipeline/outputs/opensearch.md) diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md new file mode 100644 index 000000000..94a10c91a --- /dev/null +++ b/pipeline/outputs/openobserve.md @@ -0,0 +1,49 @@ +--- +title: OpenObserve +description: Send logs to OpenObserve using Fluent Bit +--- + +# OpenObserve + +Use the OpenObserve output plugin to ingest logs into [OpenObserve](https://openobserve.ai/). + +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 + +| 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` | +| 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. | _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` | +| 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 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 + +Use this configuration file to get started: + +``` +[OUTPUT] + Name http + Match * + URI /api/default/default/_json + Host localhost + Port 5080 + tls on + Format json + Json_date_key timestamp + Json_date_format iso8601 + HTTP_User <YOUR_HTTP_USER> + HTTP_Passwd <YOUR_HTTP_PASSWORD> + compress gzip +``` \ No newline at end of file