|
| 1 | +--- |
| 2 | +title: OpenObserve |
| 3 | +description: Send logs to OpenObserve using Fluent Bit |
| 4 | +--- |
| 5 | + |
| 6 | +# OpenObserve |
| 7 | + |
| 8 | +Use the OpenObserve output plugin to ingest logs into [OpenObserve](https://openobserve.ai/). |
| 9 | + |
| 10 | +Before you begin, you need an [OpenObserve account](https://cloud.openobserve.ai/), an |
| 11 | +`HTTP_User`, and an `HTTP_Passwd`. You can find these fields under **Ingestion** in |
| 12 | +OpenObserve Cloud. Alternatively, you can achieve this with various installation |
| 13 | +types as mentioned in the |
| 14 | +[OpenObserve documentation](https://openobserve.ai/docs/quickstart/) |
| 15 | + |
| 16 | +## Configuration Parameters |
| 17 | + |
| 18 | +| Key | Description | Default | |
| 19 | +| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------- | |
| 20 | +| Host | Required. The OpenObserve server where you are sending logs. | `localhost` | |
| 21 | +| TLS | Required: Enable end-to-end security using TLS. Set to `on` to enable TLS communication with OpenObserve. | `on` | |
| 22 | +| compress | Recommended: Compresses the payload in GZIP format. OpenObserve supports and recommends setting this to `gzip` for optimized log ingestion. | _none_ | |
| 23 | +| HTTP_User | Required: Username for HTTP authentication. | _none_ | |
| 24 | +| HTTP_Passwd | Required: Password for HTTP authentication. | _none_ | |
| 25 | +| URI | Required: The API path used to send logs. | `/api/default/default/_json` | |
| 26 | +| Format | Required: The format of the log payload. OpenObserve expects JSON. | `json` | |
| 27 | +| json_date_key | Optional: The JSON key used for timestamps in the logs. | `timestamp` | |
| 28 | +| json_date_format | Optional: The format of the date in logs. OpenObserve supports ISO 8601. | `iso8601` | |
| 29 | +| include_tag_key | If `true`, a tag is appended to the output. The key name is used in the `tag_key` property. | `false` | |
| 30 | + |
| 31 | +### Configuration File |
| 32 | + |
| 33 | +Use this configuration file to get started: |
| 34 | + |
| 35 | +``` |
| 36 | +[OUTPUT] |
| 37 | + Name http |
| 38 | + Match * |
| 39 | + URI /api/default/default/_json |
| 40 | + Host localhost |
| 41 | + Port 5080 |
| 42 | + tls on |
| 43 | + Format json |
| 44 | + Json_date_key timestamp |
| 45 | + Json_date_format iso8601 |
| 46 | + HTTP_User <YOUR_HTTP_USER> |
| 47 | + HTTP_Passwd <YOUR_HTTP_PASSWORD> |
| 48 | + compress gzip |
| 49 | +``` |
0 commit comments