Skip to main content
Version: 0.8.1

Index a logging dataset locally

In this guide, we will index about 20 million log entries (7 GB decompressed) on a local machine. If you want to start a server with indexes on AWS S3 with several search nodes, check out the tutorial for distributed search.

Here is an example of a log entry:

"timestamp": 1460530013,
"severity_text": "INFO",
"body": "PacketResponder: BP-108841162-, type=HAS_DOWNSTREAM_IN_PIPELINE terminating",
"resource": {
"service": "datanode/01"
"attributes": {
"class": "org.apache.hadoop.hdfs.server.datanode.DataNode"
"tenant_id": 58


Let's download and install Quickwit.

curl -L | sh
cd quickwit-v*/

Or pull and run the Quickwit binary in an isolated Docker container.

docker run quickwit/quickwit --version

Start a Quickwit server

./quickwit run

Create your index

Let's create an index configured to receive these logs.

# First, download the hdfs logs config from Quickwit repository.
curl -o hdfs_logs_index_config.yaml

The index config defines five fields: timestamp, tenant_id, severity_text, body, and one JSON field for the nested values resource.service, we could use an object field here and maintain a fixed schema, but for convenience we're going to use a JSON field. It also sets the default_search_fields, the tag_fields, and the timestamp_field. The timestamp_field and tag_fields are used by Quickwit for splits pruning at query time to boost search speed. Check out the index config docs for more details.

version: 0.7

index_id: hdfs-logs

- name: timestamp
type: datetime
- unix_timestamp
output_format: unix_timestamp_secs
fast_precision: seconds
fast: true
- name: tenant_id
type: u64
- name: severity_text
type: text
tokenizer: raw
- name: body
type: text
tokenizer: default
record: position
- name: resource
type: json
tokenizer: raw
tag_fields: [tenant_id]
timestamp_field: timestamp

default_search_fields: [severity_text, body]

Now let's create the index with the create subcommand (assuming you are inside Quickwit install directory):

./quickwit index create --index-config hdfs_logs_index_config.yaml

You're now ready to fill the index.

Index logs

The dataset is a compressed NDJSON file. Instead of downloading it and then indexing the data, we will use pipes to directly send a decompressed stream to Quickwit. This can take up to 10 minutes on a modern machine, the perfect time for a coffee break.

curl | gunzip | ./quickwit index ingest --index hdfs-logs

If you are in a hurry, use the sample dataset that contains 10 000 documents, we will use this dataset for the example queries:

curl | ./quickwit index ingest --index hdfs-logs

You can check it's working by searching for INFO in severity_text field:

./quickwit index search --index hdfs-logs  --query "severity_text:INFO"

The ingest subcommand generates splits of 5 million documents. Each split is a small piece of index represented by a file in which index files and metadata files are saved.

The query which returns the json:

"num_hits": 10000,
"hits": [
"body": "Receiving BP-108841162- src: / dest: /",
"resource": {
"service": "datanode/03"
"severity_text": "INFO",
"tenant_id": 58,
"timestamp": 1440670490
"elapsed_time_micros": 2490

The index config shows that we can use the timestamp field parameters start_timestamp and end_timestamp and benefit from time pruning. Behind the scenes, Quickwit will only query splits that have logs in this time range.

Let's use these parameters with the following query:

curl ''


Let's do some cleanup by deleting the index:

./quickwit index delete --index hdfs-logs

Congratz! You finished this tutorial!

To continue your Quickwit journey, check out the tutorial for distributed search or dig into the search REST API or query language.