Merge pull request #1960 from fluent/lynettemiles/sc-136255/update-fluent-bit-docs-pipeline-outputs-openobserve

Author: esmerel

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 %}
+{% endtabs %}

vale-styles/FluentBit/Acronyms.yml

@@ -52,6 +52,7 @@ exceptions:
   - IAM
   - IDE
   - IMDS
+  - ISO
   - JAR
   - JSON
   - JSX

vale-styles/FluentBit/Headings.yml

@@ -72,6 +72,7 @@ exceptions:
   - Observability Platform
   - Okta
   - OpenMetrics
+  - OpenObserve
   - OpenTelemetry
   - Opsgenie
   - PagerDuty

vale-styles/FluentBit/Spelling-exceptions.txt

@@ -126,6 +126,7 @@ OAuth
 Okta
 Onigmo
 Oniguruma
+OpenObserve
 OpenTelemetry
 Opsgenie
 OTel