Skip to content

Pipeline: output: openobserve: style #1960

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 22, 2025
Merged

Pipeline: output: openobserve: style #1960

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ffc349
Pipeline: output: openobserve: style
esmerel Jul 21, 2025
abe786b
Update openobserve.md
esmerel Jul 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
49 changes: 26 additions & 23 deletions pipeline/outputs/openobserve.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:

Expand All @@ -53,6 +55,7 @@ pipeline:
compress: gzip

```

{% endtab %}
{% tab title="fluent-bit.conf" %}

Expand All @@ -73,4 +76,4 @@ pipeline:
```

{% endtab %}
{% endtabs %}
{% endtabs %}
1 change: 1 addition & 0 deletions vale-styles/FluentBit/Acronyms.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,7 @@ exceptions:
- IAM
- IDE
- IMDS
- ISO
- JAR
- JSON
- JSX
Expand Down
1 change: 1 addition & 0 deletions vale-styles/FluentBit/Headings.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ exceptions:
- Observability Platform
- Okta
- OpenMetrics
- OpenObserve
- OpenTelemetry
- Opsgenie
- PagerDuty
Expand Down
1 change: 1 addition & 0 deletions vale-styles/FluentBit/Spelling-exceptions.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,6 +126,7 @@ OAuth
Okta
Onigmo
Oniguruma
OpenObserve
OpenTelemetry
Opsgenie
OTel
Expand Down