Skip to content

Bump format version from 0.5 to 0.6 #3338

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
May 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion .github/workflows/ui-ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ jobs:
CI=false yarn --cwd quickwit-ui build
cargo build --features=postgres
mkdir qwdata
cargo run --features=postgres -- run --service searcher --service metastore --config ../config/quickwit.yaml &
# Workaround for possible rust regression - https://github.com/quickwit-oss/quickwit/issues/3346
target/debug/quickwit run --service searcher --service metastore --config ../config/quickwit.yaml &
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

why?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A workaround for #3346

yarn --cwd quickwit-ui cypress run
- name: Lint
command: yarn --cwd quickwit-ui lint
Expand Down
2 changes: 1 addition & 1 deletion config/quickwit.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
#
# Config file format version.
#
version: 0.5
version: 0.6
#
# Node ID. Must be unique within a cluster. If not set, a random node ID is generated on each startup.
#
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# Index config file for gh-archive dataset.
#
version: 0.5
version: 0.6

index_id: gh-archive

Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/gh-archive/index-config.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# Index config file for gh-archive dataset.
#
version: 0.5
version: 0.6

index_id: gh-archive

Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/gh-archive/kafka-source.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 0.5
version: 0.6
source_id: kafka-source
source_type: kafka
params:
Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/gh-archive/kinesis-source.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 0.5
version: 0.6
source_id: kinesis-source
source_type: kinesis
params:
Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/hdfs-logs/index-config-partitioned.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Index config file for hdfs-logs dataset with partitioning configured.
#

version: 0.5
version: 0.6

index_id: hdfs-logs-partitioned

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Index config file for hdfs-logs dataset with a retention policy configured.
#

version: 0.5
version: 0.6

index_id: hdfs-logs-retention-policy

Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/hdfs-logs/index-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Index config file for hdfs-logs dataset.
#

version: 0.5
version: 0.6

index_id: hdfs-logs

Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/hdfs-logs/searcher-1.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 0.5
version: 0.6
node_id: searcher-1
listen_address: 127.0.0.1
rest_listen_port: 7280
Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/hdfs-logs/searcher-2.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 0.5
version: 0.6
node_id: searcher-2
listen_address: 127.0.0.1
rest_listen_port: 7290
Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/hdfs-logs/searcher-3.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 0.5
version: 0.6
node_id: searcher-3
listen_address: 127.0.0.1
rest_listen_port: 7300
Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/otel-logs/index-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Link: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md
#

version: 0.5
version: 0.6

index_id: otel-log-v0

Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/otel-trace/index-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Link: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md
#

version: 0.5
version: 0.6

index_id: otel-trace-v0

Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/stackoverflow/index-config.yaml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#
# Index config file for stackoverflow dataset.
#
version: 0.5
version: 0.6

index_id: stackoverflow

Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/stackoverflow/pulsar-source.yaml
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
version: 0.5
version: 0.6
source_id: pulsar-source
source_type: pulsar
params:
Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/vector-otel-logs/index-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
# Link: https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/logs/data-model.md
#

version: 0.5
version: 0.6

index_id: vector-otel-logs

Expand Down
2 changes: 1 addition & 1 deletion config/tutorials/wikipedia/index-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
# Index config file for wikipedia dataset.
#

version: 0.5
version: 0.6

index_id: wikipedia

Expand Down
14 changes: 7 additions & 7 deletions docs/configuration/index-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ The index configuration format is YAML. When a key is absent from the configurat
Here is a complete example suited for the HDFS logs dataset:

```yaml
version: 0.5 # File format version.
version: 0.6 # File format version.

index_id: "hdfs"

Expand Down Expand Up @@ -387,7 +387,7 @@ The configuration of `dynamic` mode can be set via the `dynamic_mapping` paramet
`dynamic_mapping` offers the same configuration options as when configuring a `json` field. It defaults to:

```yaml
version: 0.5
version: 0.6
index_id: my-dynamic-index
doc_mapping:
mode: dynamic
Expand All @@ -407,7 +407,7 @@ the root of the JSON object.
For instance, in a entirely schemaless settings, a minimal index configuration could be:

```yaml
version: 0.5
version: 0.6
index_id: my-dynamic-index
# note we did not map anything.
doc_mapping:
Expand Down Expand Up @@ -492,7 +492,7 @@ Quickwit's default merge policy is the `stable_log` merge policy
with the following parameters:

```yaml
version: 0.5
version: 0.6
index_id: "hdfs"
# ...
indexing_settings:
Expand Down Expand Up @@ -520,7 +520,7 @@ of the number of merge operation a split should undergo.


```yaml
version: 0.5
version: 0.6
index_id: "hdfs"
# ...
indexing_settings:
Expand Down Expand Up @@ -548,7 +548,7 @@ This setting is not recommended. Merges are necessary to reduce the number of sp
:::

```yaml
version: 0.5
version: 0.6
index_id: "hdfs"
indexing_settings:
merge_policy:
Expand All @@ -575,7 +575,7 @@ This section describes search settings for a given index.
This section describes how Quickwit manages data retention. In Quickwit, the retention policy manager drops data on a split basis as opposed to individually dropping documents. Splits are evaluated based on their `time_range` which is derived from the index timestamp field specified in the (`indexing_settings.timestamp_field`) settings. Using this setting, the retention policy will delete a split when `now() - split.time_range.end >= retention_policy.period`

```yaml
version: 0.5
version: 0.6
index_id: hdfs
# ...
retention:
Expand Down
6 changes: 3 additions & 3 deletions docs/configuration/node-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ export QW_LISTEN_ADDRESS=0.0.0.0

```yaml
# config.yaml
version: 0.5
version: 0.6
cluster_id: quickwit-cluster
node_id: my-unique-node-id
listen_address: ${QW_LISTEN_ADDRESS}
Expand All @@ -120,7 +120,7 @@ rest_listen_port: ${QW_LISTEN_PORT:-1111}
Will be interpreted by Quickwit as:

```yaml
version: 0.5
version: 0.6
cluster_id: quickwit-cluster
node_id: my-unique-node-id
listen_address: 0.0.0.0
Expand All @@ -135,7 +135,7 @@ by default no origins are allowed.
A wildcard, single origin or multiple origins can be specified as part of the `rest_cors_allow_origins` parameter:

```yaml
version: 0.5
version: 0.6
index_id: hdfs

rest_cors_allow_origins: '*' # Allow all origins
Expand Down
6 changes: 3 additions & 3 deletions docs/configuration/source-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ Short max poll interval durations may cause a source to crash when back pressure

```bash
cat << EOF > source-config.yaml
version: 0.5
version: 0.6
source_id: my-kafka-source
source_type: kafka
params:
Expand Down Expand Up @@ -119,7 +119,7 @@ If no region is specified, Quickwit will attempt to find one in multiple other l

```bash
cat << EOF > source-config.yaml
version: 0.5
version: 0.6
source_id: my-kinesis-source
source_type: kinesis
params:
Expand Down Expand Up @@ -148,7 +148,7 @@ The Pulsar source consumes `topics` using the client library [pulsar-rs](https:/

```bash
cat << EOF > source-config.yaml
version: 0.5
version: 0.6
source_id: my-pulsar-source
source_type: pulsar
params:
Expand Down
2 changes: 1 addition & 1 deletion docs/distributed-tracing/otel-service.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ Below is the doc mapping of the `otel-trace-v0` index:

```yaml

version: 0.5
version: 0.6

index_id: otel-trace-v0

Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/quickstart.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ And here is the complete config:
#
# Index config file for stackoverflow dataset.
#
version: 0.5
version: 0.6

index_id: stackoverflow

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ We don't need to index all fields described above as `title` and `body` are the
The `id` will be helpful for making the JOINs in ClickHouse, `created_at` and `event_type` may also be beneficial for timestamp pruning and filtering.

```yaml title="gh-archive-index-config.yaml"
version: 0.5
version: 0.6
index_id: gh-archive
# By default, the index will be stored in your data directory,
# but you can store it on s3 or on a custom path as follows:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ Now we can create a Quickwit config file.

```bash
# Create Quickwit config file.
echo "version: 0.5
echo "version: 0.6
node_id: searcher-1
listen_address: 0.0.0.0
metastore_uri: ${S3_PATH}
Expand All @@ -70,7 +70,7 @@ default_index_root_uri: ${S3_PATH}
> # config.yaml
> node_id: searcher-1
> listen_address: 0.0.0.0
> version: 0.5
> version: 0.6
> metastore_uri: ${S3_PATH}
> default_index_root_uri: ${S3_PATH}
>```
Expand All @@ -95,7 +95,7 @@ used by Quickwit for [splits pruning](../../overview/architecture) at query time
Check out the [index config docs](../../configuration/index-config) for more details.

```yaml title="hdfs_logs_index_config.yaml"
version: 0.5
version: 0.6

index_id: hdfs-logs

Expand Down Expand Up @@ -195,7 +195,7 @@ export IP_NODE_1={first-ec2-instance-public-ip}

```bash
# configuration for our second node
echo "version: 0.5
echo "version: 0.6
node_id: searcher-2
metastore_uri: ${S3_PATH}
default_index_root_uri: ${S3_PATH}
Expand All @@ -210,7 +210,7 @@ peer_seeds:

```bash
# configuration for our third node
echo "version: 0.5
echo "version: 0.6
node_id: searcher-3
listen_address: 0.0.0.0
peer_seeds:
Expand Down
2 changes: 1 addition & 1 deletion docs/get-started/tutorials/tutorial-hdfs-logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ The `timestamp_field` and `tag_fields` are used by Quickwit for [splits pruning]
Check out the [index config docs](../../configuration/index-config) for more details.

```yaml title="hdfs-logs-index.yaml"
version: 0.5
version: 0.6

index_id: hdfs-logs

Expand Down
10 changes: 5 additions & 5 deletions docs/guides/schemaless.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ As a user, you need to precisely define the list of fields to be ingested by Qui
For instance, a reasonable mapping for an application log could be:

```yaml title=my_strict_index.yaml
version: 0.5
version: 0.6

index_id: my_strict_index

Expand Down Expand Up @@ -70,7 +70,7 @@ By default, this catch-all configuration indexes and stores all of these fields,
A minimalist, yet perfectly valid and useful index configuration is then:

```yaml title=my_dynamic_index.yaml
version: 0.5
version: 0.6
index_id: my_dynamic_index
doc_mapping:
mode: dynamic
Expand Down Expand Up @@ -115,7 +115,7 @@ Each event type comes with its own set of attributes. Declaring our mapping as t
Instead, we can cherry-pick the fields that are common to all of the logs, and rely on dynamic mode to handle the rest.

```yaml title=my_dynamic_index.yaml
version: 0.5
version: 0.6
index_id: my_dynamic_index
doc_mapping:
mode: dynamic
Expand Down Expand Up @@ -149,7 +149,7 @@ Execute the following commands to create the index, ingest a few documents and s

```bash
cat << EOF > my_dynamic_index.yaml
version: 0.5
version: 0.6
index_id: my_dynamic_index
doc_mapping:
mode: dynamic
Expand Down Expand Up @@ -219,7 +219,7 @@ Quickwit 0.3 introduced a JSON field type to handle this use case.
A good index configuration here could be:

```yaml title=otel_logs.yaml
version: 0.5
version: 0.6
index_id: otel_logs
doc_mapping:
mode: dynamic
Expand Down
2 changes: 1 addition & 1 deletion docs/ingest-data/ingest-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ First, let's create a schemaless index.
```bash
# Create the index config file.
cat << EOF > stackoverflow-schemaless-config.yaml
version: 0.5
version: 0.6
index_id: stackoverflow-schemaless
doc_mapping:
mode: dynamic
Expand Down
Loading