# OpenObserve

Use the OpenObserve output plugin to ingest logs into [OpenObserve](https://openobserve.ai/).

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:

{% tabs %}
{% tab title="fluent-bit.yaml" %}

```yaml
pipeline:

  outputs:
    - 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

```

{% endtab %}

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

```
[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
```

{% endtab %}
{% endtabs %}