Skip to content

Commit

Permalink
[vParquet2] mention the new block format in the configuration docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stoewer committed Mar 30, 2023
1 parent a5eb9e5 commit 284beca
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 8 deletions.
2 changes: 1 addition & 1 deletion docs/sources/tempo/configuration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -987,7 +987,7 @@ storage:

# block configuration
block:
# block format version. options: v2, vParquet
# block format version. options: v2, vParquet, vParquet2
[version: <string> | default = vParquet]

# bloom filter false positive rate. lower values create larger filters but fewer false positives
Expand Down
21 changes: 14 additions & 7 deletions docs/sources/tempo/configuration/parquet.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,23 +17,30 @@ If you install using the new Helm charts, then Parquet is enabled by default.

## Considerations

The new Parquet block is enabled by default in Tempo 2.0. No data conversion or upgrade process is necessary. As soon as the Parquet format is enabled, Tempo starts writing data in that format, leaving existing data as-is.
The Parquet block format is enabled by default in Tempo 2.0. No data conversion or upgrade process is necessary. As soon as the format is enabled, Tempo starts writing data in that format, leaving existing data as-is.

The new Parquet block format requires more CPU and memory resources than the previous v2 format but provides search and TraceQL functionality.
Block formats based on Parquet require more CPU and memory resources than the previous `v2` format but provide search and TraceQL functionality.

## Disable Parquet
## Choose a different block format

It is possible to disable Parquet and use the previous v2 block format. This disables all forms of search, but also reduces resource consumption, and may be desired for a high-throughput cluster that does not need these capabilities. Set the block format option to v2 in the Storage section of the configuration file.
It is possible to disable Parquet and use the previous `v2` block format. This disables all forms of search, but also reduces resource consumption, and may be desired for a high-throughput cluster that does not need these capabilities. Set the block version option to `v2` in the Storage section of the configuration file.

```yaml
# block format version. options: v2, vParquet
# block format version. options: v2, vParquet, vParquet2
[version: v2]
```
To re-enable Parquet, set the block format option to `vParquet` in the Storage section of the configuration file.
There is also a revised version of the Parquet base block format `vParquet2`. This version improves the interoperability with other tools based on Parquet. `vParquet2` is still experimental and not enabled by default yet. To enable it, set the block format version to `vParquet2` in the Storage section of the configuration file.

```yaml
# block format version. options: v2, vParquet
# block format version. options: v2, vParquet, vParquet2
[version: vParquet2]
```

To re-enable Parquet, set the block version option to `vParquet` in the Storage section of the configuration file.

```yaml
# block format version. options: v2, vParquet, vParquet2
[version: vParquet]
```

Expand Down

0 comments on commit 284beca

Please sign in to comment.