Search more with less

The new way to manage your logs at any scale

Quickstart | Docs | Tutorials | Chat | Download

❗Disclaimer: you are reading the README of Quickwit 0.3 version that will be shipped in May 2022.

Quickwit is the next-gen search & analytics engine built for log management. It is a highly reliable & cost-efficient alternative to Elasticsearch.

💡 Features

Index data persisted on object storage
Ingest JSON documents with or without a strict schema
Ingest & Aggregation API Elasticsearch compatible
Lightweight Embedded UI
Runs on a fraction of the resources: written in Rust, powered by the mighty tantivy
Works out of the box with sensible defaults
Optimized for multi-tenancy. Add and scale tenants with no overhead costs
Distributed search
Cloud-native: Kubernetes ready
Add and remove nodes in seconds
Decoupled compute & storage
Sleep like a log: all your indexed data is safely stored on object storage (AWS S3...)
Ingest your documents with exactly-once semantics
Kafka-native ingestion
Search stream API that notably unlocks full-text search in ClickHouse

🔮 Upcoming Features

Ingest your logs from your object storage
Distributed indexing
Support for tracing
Native support for OpenTelemetry

🔎 Uses & Limitations

✅ When to use	❌ When not to use
Your documents are immutable: application logs, system logs, access logs, user actions logs, audit trail (logs), etc.	Your documents are mutable.
Your data has a time component. Quickwit includes optimizations and design choices specifically related to time.	You need a low-latency search for e-commerce websites.
You want a full-text search in a multi-tenant environment.	You provide a public-facing search with high QPS.
You want to index directly from Kafka.	You want to re-score documents at query time.
You want to add full-text search to your ClickHouse cluster.
You ingest a tremendous amount of logs and don't want to pay huge bills.
You ingest a tremendous amount of data and you don't want to waste your precious time babysitting your cluster.

⚡ Getting Started

Let's download and install Quickwit.

curl -L https://install.quickwit.io | sh

You can now move this executable directory wherever sensible for your environment and possibly add it to your PATH environment. You can also install it via other means.

Take a look at our Quick Start to do amazing things, like Creating your first index or Adding some documents, or take a glance at our full Installation guide!

📚 Tutorials

💬 Community

Chat with us in Discord
📝 Blog Posts
📺 Youtube Videos
Follow us on Twitter

🙋 FAQ

How is Quickwit different from traditional search engines like Elasticsearch or Solr?

The core difference and advantage of Quickwit is its architecture that is built from the ground up for cloud and log management. Optimized IO paths make search on object storage sub-second and thanks to the true decoupled compute and storage, search instances are stateless, it is possible to add or remove search nodes within seconds. Last but not least, we implemented a highly-reliable distributed search and exactly-once semantics during indexing so that all engineers can sleep at night. All this slashes costs for log management.

How does Quickwit compare to Elastic in terms of cost?

We estimate that Quickwit can be up to 10x cheaper on average than Elastic. To understand how, check out our blog post about searching the web on AWS S3.

What license does Quickwit use?

Quickwit is open-source under the GNU Affero General Public License Version 3 - AGPLv3. Fundamentally, this means that you are free to use Quickwit for your project, as long as you don't modify Quickwit. If you do, you have to make the modifications public. We also provide a commercial license for enterprises to provide support and a voice on our roadmap.

What is Quickwit's business model?

Our business model relies on our commercial license. There is no plan to become SaaS in the near future.

🪄 Third-Party Integration

🤝 Contribute and spread the word

We are always super happy to have contributions: code, documentation, issues, feedback, or even saying hello on discord! Here is how you can help us build the future of log management:

Have a look through GitHub issues labeled "Good first issue".
Read our Contributor Covenant Code of Conduct
Create a fork of Quickwit and submit your pull request!

✨ And to thank you for your contributions, claim your swag by emailing us at hello at quickwit.io.

bkbase-plugin / quickwit Goto Github PK

quickwit's Introduction