diff --git a/pipeline/outputs/openobserve.md b/pipeline/outputs/openobserve.md index 9314fb90f..83a85aa5d 100644 --- a/pipeline/outputs/openobserve.md +++ b/pipeline/outputs/openobserve.md @@ -7,28 +7,30 @@ 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 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 +Before you begin, you need the following fields, which can be found 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/): + +- [OpenObserve account](https://cloud.openobserve.ai/) +- `HTTP_User` +- `HTTP_Passwd` + +## Configuration parameters + +This plugin supports the following parameters: + +| Key | Description | Default | +| --- | ----------- | ------- | +| `Host` | The OpenObserve server where you are sending logs. | `localhost` | +| `TLS` | 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 recommends setting this to `gzip` for optimized log ingestion. | _none_ | +| `HTTP_User` | Username for HTTP authentication. | _none_ | +| `HTTP_Passwd` | Password for HTTP authentication. | _none_ | +| `URI` | The API path used to send logs. | `/api/default/default/_json` | +| `Format` | 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: @@ -53,6 +55,7 @@ pipeline: compress: gzip ``` + {% endtab %} {% tab title="fluent-bit.conf" %} @@ -73,4 +76,4 @@ pipeline: ``` {% endtab %} -{% endtabs %} \ No newline at end of file +{% endtabs %} diff --git a/vale-styles/FluentBit/Acronyms.yml b/vale-styles/FluentBit/Acronyms.yml index c7422ef1a..bca826252 100644 --- a/vale-styles/FluentBit/Acronyms.yml +++ b/vale-styles/FluentBit/Acronyms.yml @@ -52,6 +52,7 @@ exceptions: - IAM - IDE - IMDS + - ISO - JAR - JSON - JSX diff --git a/vale-styles/FluentBit/Headings.yml b/vale-styles/FluentBit/Headings.yml index fb109ae38..6cb6a1d0f 100644 --- a/vale-styles/FluentBit/Headings.yml +++ b/vale-styles/FluentBit/Headings.yml @@ -69,6 +69,7 @@ exceptions: - Observability Platform - Okta - OpenMetrics + - OpenObserve - OpenTelemetry - Opsgenie - PagerDuty diff --git a/vale-styles/FluentBit/Spelling-exceptions.txt b/vale-styles/FluentBit/Spelling-exceptions.txt index cb93d5899..e49c3889f 100644 --- a/vale-styles/FluentBit/Spelling-exceptions.txt +++ b/vale-styles/FluentBit/Spelling-exceptions.txt @@ -126,6 +126,7 @@ OAuth Okta Onigmo Oniguruma +OpenObserve OpenTelemetry Opsgenie OTel