# OpenObserve

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

Use this configuration file to get started:

```
[OUTPUT]
  Name http
  Match *
  URI /api/default/default/_json
  Host localhost
  Port 5080
  tls on
  Format json
  Json_date_key    timestamp
  Json_date_format iso8601
  HTTP_User <YOUR_HTTP_USER>
  HTTP_Passwd <YOUR_HTTP_PASSWORD>
  compress gzip
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.fluentbit.io/manual/3.1/pipeline/outputs/openobserve.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.