-
Notifications
You must be signed in to change notification settings - Fork 496
Update introduction. #1075
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
Update introduction. #1075
Changes from all commits
Commits
Show all changes
10 commits
Select commit
Hold shift + click to select a range
c483760
Update introduction.
fmassot 5bff581
Update docs/introduction.md
fmassot 52b0092
Update docs/introduction.md
fmassot 98ff429
Update docs/introduction.md
fmassot 7332648
Update docs/introduction.md
fmassot dc24d7f
Update docs/introduction.md
fmassot d1e0cd5
Update docs/introduction.md
fmassot 5ef96a8
Update docs/introduction.md
fmassot c33d712
Fix link.
fmassot 6691e22
Fix footnote
fmassot File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,29 +1,53 @@ | ||
| --- | ||
| title: What is Quickwit? | ||
| title: Introduction | ||
| slug: / | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| Quickwit is a distributed search engine built from the ground up to offer cost-efficiency and high reliability. By mere mortals for mere mortals, Quickwit's architecture is as simple as possible[^1]. | ||
| Quickwit is a distributed search engine designed from the ground up to offer cost-efficiency and high reliability on large data sets. | ||
|
|
||
| Quickwit is written in Rust and built on top of the mighty [tantivy](https://github.com/tantivy-search/tantivy) library. We designed it to index large datasets. | ||
| Quickwit is particularly well-suited for dealing with large, immutable datasets and relatively low average QPS<sup>[1](#footnote1)</sup>. Its benefits are most apparent in multi-tenancy or multi-index settings. | ||
|
|
||
| ## Why Quickwit? | ||
| Common use cases for Quickwit include: | ||
|
|
||
| Quickwit is born from the idea that today's search engines are hard to manage and uneconomical when dealing with large datasets and a low QPS[^2] rate. Its benefits are most apparent in a multitenancy or a multi-index setting. | ||
| - Searching through logs, from small amounts of data to terabytes. | ||
| - Adding full-text search capabilities to [OLAP databases such as ClickHouse](./guides/add-full-text-search-to-your-olap-db.md). | ||
| - Searching through backups sitting on your cloud storage by adding Quickwit index files on your same storage. | ||
|
|
||
| Quickwit allows true decoupled compute and storage. | ||
| We designed it to search straight from object storage like Amazon S3 in a stateless manner. | ||
| # Key features of Quickwit | ||
|
|
||
| Imagine hosting an arbitrary amount of indexes on Amazon S3 for $25 per TB/month and querying them with the same pool of search servers and with a subsecond latency. | ||
| Quickwit is designed to search straight from object storage allowing true decoupled compute and storage. Here is a non-exhaustive list of Quickwit’s key features: | ||
|
|
||
| Not only is Quickwit more cost-efficient, but search clusters are also easier to operate. One can add or remove search instances in seconds. You can also effortlessly index a massive amount of historical data using your favorite batch technology. Last but not least, Multi-tenant search is now cheap and painless. | ||
| - **Scalable distributed search:** Host an arbitrary number of indexes on Amazon S3 and answer search queries in less than a second with a small pool of stateless search instances. | ||
| - **Stream indexing:** Ingest TB of data from your favorite distributed event streaming service. As of today, Quickwit supports Apache Kafka natively. The next releases will bring support for more platforms. | ||
| - **Fault-tolerant architecture that won't lose data:** Quickwit achieves **exactly-once** processing for indexing and safely stores your data on highly reliable object storage services such as Amazon S3. | ||
| - **Cloud-native, easy to operate:** Thanks to true decoupled compute and storage, search instances are stateless, add or remove search nodes within seconds. | ||
| - **Sub-second full-text search on cloud / distributed storage:** Quickwit Search re-designed indexing and index data structure to open it in less than 60ms on Amazon S3**.** | ||
| - **Time-based sharding:** Quickwit shards data by time when enabled. And you can use a second dimension to shard data thanks to our [tags feature](./design/querying.md). Time-based queries only access splits (a data piece of the index) that match the time range of the query which leads to significant performance improvements. | ||
| - **Painless multi-tenant search:** Create indexes for each tenant without hurting query performance. Or group tenants into one index and use tagging to prune irrelevant splits for your tenant query to improve significantly performance. | ||
|
|
||
| - [Take a look at the feature set](overview/features.md) | ||
| - [Get started](getting-started/quickstart.md) | ||
| # When to use Quickwit | ||
|
|
||
| Quickwit should be a good match if your use case has some of the following characteristics: | ||
|
|
||
| --- | ||
| [^1] ... But not one bit simpler. | ||
| - Your documents are immutable. | ||
| - You are targeting query latencies of 100ms to a few seconds. | ||
| - You have a low average QPS<sup>[1](#footnote1)</sup>, typically < 10 QPS on average over the month. This is the case for most search use cases as long as search is not public: enterprise search, log search, email search, security search, ... | ||
| - Your data has a time component. Quickwit includes optimizations and design choices specifically related to time. | ||
| - You want to load data from Kafka, local files (and soon directly from object storage like Amazon S3). | ||
| - You want full-text search in a multi-tenant environment. | ||
|
|
||
| Use cases where you would likely *not* want to use Quickwit include: | ||
|
|
||
| - You need a low-latency search for e-commerce websites. | ||
| - Your data are mutable. | ||
|
|
||
| # Learn more | ||
|
|
||
| [^2] QPS stands for Queries per second. It is a standard measure of the amount of search traffic. | ||
| - [Quickstart](./get-started/quickstart.md) | ||
| - [Architecture](./design/architecture.md) | ||
| - [0.2 Release](https://quickwit.io/blog/quickwit-0.2) | ||
|
|
||
|
|
||
| --- | ||
| <a name="footnote1">1.</a>: QPS stands for Queries per second. It is a standard measure of the amount of search traffic. Low average QPS is typically under 10. This is the case for most search use cases as long as search is not public: enterprise search, log search, email search, security search, ... | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.