Skip to content

Commit a91d2e7

Browse files
committed
Document OTLP source input formats
1 parent 105aa7d commit a91d2e7

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

docs/configuration/source-config.md

+15-5
Original file line numberDiff line numberDiff line change
@@ -257,11 +257,21 @@ transform:
257257
258258
## Input format
259259
260-
The `input_format` parameter specifies the expected data format of the source. Two formats are currently supported:
261-
- `json`: JSON, the default
262-
- `plain_text`: unstructured text document
260+
The `input_format` parameter specifies the expected data format of the source. The formats currently supported are:
261+
- `json` (default)
262+
- `otlp_logs_json`
263+
- `otlp_logs_proto`
264+
- `otlp_traces_json`
265+
- `otlp_traces_proto`
266+
- `plain_text`
263267

264-
Internally, Quickwit can only index JSON data. To allow the ingestion of plain text documents, Quickwit transform them on the fly into JSON objects of the following form: `{"plain_text": "<original plain text document>"}`. Then, they can be optionally transformed into more complex documents using a VRL script. (see [transform feature](#transform-parameters)).
268+
*OTLP formats*
269+
270+
When ingesting OTLP data into an OTLP logs or traces index with a source other than the native OTEL endpoints, use this parameter to specify whether the exported logs or traces will be serialized in JSON or Protobuf. When possible, prefer the latter, which is a more compact encoding.
271+
272+
*Plaint text format*
273+
274+
Use this parameter for unstructured text data. Internally, Quickwit can only index JSON data. To allow the ingestion of plain text documents, Quickwit transform them on the fly into JSON objects of the following form: `{"plain_text": "<original plain text document>"}`. Then, they can be optionally transformed into more complex documents using a VRL script. (see [transform feature](#transform-parameters)).
265275

266276
The following is an example of how one could parse and transform a CSV dataset containing a list of users described by 3 attributes: first name, last name, and age.
267277

@@ -278,7 +288,7 @@ transform:
278288
del(.plain_text)
279289
```
280290

281-
## Enabling/Disabling a source from an index
291+
## Enabling/disabling a source from an index
282292

283293
A source can be enabled or disabled from an index using the [CLI command](../reference/cli.md) `quickwit source enable` or `quickwit source disable`:
284294

0 commit comments

Comments
 (0)