Skip to content

Commit

Permalink
Backport docs corrections from quickwit.io (quickwit-oss#1127)
Browse files Browse the repository at this point in the history
  • Loading branch information
ddelemeny authored Feb 3, 2022
1 parent 26d4f5c commit fd0eb6c
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 4 deletions.
6 changes: 3 additions & 3 deletions docs/design/architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ A Quickwit index stores documents and makes it possible to query them efficientl
A document is a collection of fields. Fields can be stored in different data structures:

- an inverted index, which enables fast full-text search.
- a columnar storage called `fast field`. It is the equivalent of doc values in [Lucene]([https://lucene.apache.org/](https://lucene.apache.org/)). Fast fields are required to compute aggregates over the documents matching a query. They can also allow some advanced types of filtering.
- a columnar storage called `fast field`. It is the equivalent of doc values in [Lucene](https://lucene.apache.org/). Fast fields are required to compute aggregates over the documents matching a query. They can also allow some advanced types of filtering.
- a row-storage called the doc store. It makes it possible to get the content of the matching documents.

You can configure your index to control how to map your JSON object to a Quickwit document and, for each field, define whether it should be stored, indexed, or be a fast field. [Learn how to configure your index](../reference/index-config.pd)
You can configure your index to control how to map your JSON object to a Quickwit document and, for each field, define whether it should be stored, indexed, or be a fast field. [Learn how to configure your index](../reference/index-config.md)

### Splits

Expand Down Expand Up @@ -94,7 +94,7 @@ Thanks to the hotcache, opening a split on Amazon S3 only takes 60ms. It makes i

**Cluster discovery**

Quickwit uses a gossip protocol to manage membership and broadcast messages to the cluster provided by [artillery project](https://github.com/bastion-rs/artillery/). The gossip protocol is based on [SWIM: Scalable Weakly-consistent Infection-style Process Group Membership Protocol]([https://www.cs.cornell.edu/projects/Quicksilver/public_pdfs/SWIM.pdf](https://www.cs.cornell.edu/projects/Quicksilver/public_pdfs/SWIM.pdf)) with a few minor adaptations.
Quickwit uses a gossip protocol to manage membership and broadcast messages to the cluster provided by [artillery project](https://github.com/bastion-rs/artillery/). The gossip protocol is based on [SWIM: Scalable Weakly-consistent Infection-style Process Group Membership Protocol](https://www.cs.cornell.edu/projects/Quicksilver/public_pdfs/SWIM.pdf) with a few minor adaptations.

**Rendezvous hashing**

Expand Down
2 changes: 1 addition & 1 deletion docs/reference/index-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,7 @@ This section describes indexing settings for a given index.
| `resources.num_threads` | Number of threads per source. | 1 |
| `resources.heap_size` | Indexer heap size per source per index. | 2_000_000_000 |

(1) [Learn more on time sharding]( ../design/architecture.md)
(1) [Learn more on time sharding](./../design/architecture.md)


### Indexer memory usage
Expand Down

0 comments on commit fd0eb6c

Please sign in to comment.