Skip to content

Commit 2ab866f

Browse files
Chaitanya SistlaChaitanya Sistla
authored andcommitted
adding openobserve details for fluentbit output
Signed-off-by: Chaitanya Sistla <[email protected]>
1 parent 90d1846 commit 2ab866f

File tree

1 file changed

+44
-0
lines changed

1 file changed

+44
-0
lines changed

pipeline/outputs/openobserve.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
---
2+
description: Send logs to OpenObserve using Fluent Bit
3+
---
4+
5+
# OpenObserve
6+
7+
The OpenObserve output plugin allows to ingest your logs into [OpenObserve](https://openobserve.ai/).
8+
9+
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/)
10+
11+
## Configuration Parameters
12+
13+
| Key | Description | Default |
14+
| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- |
15+
| Host | _Required_ - The OpenObserve server where you are sending your logs. | `localhost` |
16+
| TLS | _Required_ - Enable end-to-end security using TLS. Set to `on` to enable TLS communication with OpenObserve. | `on` |
17+
| compress | _Recommended_ - Compresses the payload in GZIP format. OpenObserve supports and recommends setting this to `gzip` for optimized log ingestion. | |
18+
| HTTP_User | _Required_ - Username for HTTP authentication. | |
19+
| HTTP_Passwd | _Required_ - Password for HTTP authentication. | |
20+
| URI | _Required_ - The API path where the logs will be sent. | `/api/default/default/_json` |
21+
| Format | _Required_ - The format of the log payload. OpenObserve expects json. | `json` |
22+
| json_date_key | _Optional_ The JSON key used for timestamps in the logs. | `timestamp` |
23+
| json_date_format | _Optional_ The format of the date in logs. OpenObserve supports iso8601. | `iso8601` |
24+
| include_tag_key | If enabled, a tag is appended to output. The key name is used `tag_key` property. | `false` |
25+
26+
### Configuration File
27+
28+
Get started quickly with this configuration file:
29+
30+
```
31+
[OUTPUT]
32+
Name http
33+
Match *
34+
URI /api/default/default/_json
35+
Host localhost
36+
Port 5080
37+
tls Off
38+
Format json
39+
Json_date_key _timestamp
40+
Json_date_format iso8601
41+
HTTP_User <your_http_user>
42+
HTTP_Passwd <your_http_password>
43+
compress gzip
44+
```

0 commit comments

Comments
 (0)