diff --git a/docs/configuration/source-config.md b/docs/configuration/source-config.md index b51cb70f545..30894d3faad 100644 --- a/docs/configuration/source-config.md +++ b/docs/configuration/source-config.md @@ -257,11 +257,21 @@ transform: ## Input format -The `input_format` parameter specifies the expected data format of the source. Two formats are currently supported: -- `json`: JSON, the default -- `plain_text`: unstructured text document +The `input_format` parameter specifies the expected data format of the source. The formats currently supported are: +- `json` (default) +- `otlp_logs_json` +- `otlp_logs_proto` +- `otlp_traces_json` +- `otlp_traces_proto` +- `plain_text` -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": ""}`. Then, they can be optionally transformed into more complex documents using a VRL script. (see [transform feature](#transform-parameters)). +*OTLP formats* + +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. + +*Plaint text format* + +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": ""}`. Then, they can be optionally transformed into more complex documents using a VRL script. (see [transform feature](#transform-parameters)). 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. @@ -278,7 +288,7 @@ transform: del(.plain_text) ``` -## Enabling/Disabling a source from an index +## Enabling/disabling a source from an index A source can be enabled or disabled from an index using the [CLI command](../reference/cli.md) `quickwit source enable` or `quickwit source disable`: