quickwit-datasource

README

Quickwit data source for Grafana

The Quickwit data source plugin allows you to query and visualize Quickwit data from within Grafana.

It is available for installation directly from the Grafana catalog or you can download the latest version and follow the installation guide.

Special thanks and a note on the license

This plugin is heavily inspired by the elasticsearch plugin available on the Grafana repository. First of all, huge thanks to the Grafana team for open-sourcing all their work.

It's more or less a fork of this plugin to adapt the code to Quickwit API. See LICENSING for details on the license and the changes made.

The license for this project is AGPL-3.0, and a notice was added to respect the Grafana Labs license.

Version compatibility

We recommand Grafana v9.5 or v10.

Quickwit 0.6 is compatible with 0.2.x versions only.

Quickwit 0.7 is compatible with 0.3.x versions only.

Installation

Download the 0.3.0 for Quickwit 0.7

wget https://github.com/quickwit-oss/quickwit-datasource/releases/download/v0.3.0/quickwit-quickwit-datasource-0.3.0.zip

Unzip into the plugins directory

mkdir -p grafana-storage/plugins
unzip quickwit-quickwit-datasource-0.3.0.zip -d grafana-storage/plugins

Download the 0.2.4 for Quickwit 0.6

wget https://github.com/quickwit-oss/quickwit-datasource/releases/download/v0.2.4/quickwit-quickwit-datasource-0.2.4.zip

Unzip into the plugins directory

mkdir -p grafana-storage/plugins
unzip quickwit-quickwit-datasource-0.2.4.zip -d grafana-storage/plugins

Start Grafana

docker run --rm -p 3000:3000 \
-e GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=quickwit-quickwit-datasource \
-v ${PWD}/grafana-storage:/var/lib/grafana \
--name grafana-enterprise grafana/grafana-enterprise

If you are running a local Quickwit instance on Linux, add the --network=host argument to the docker run command. This will allow Grafana to access services on the host machine. You can later use http://localhost:7280/api/v1 in the Quickwit API URL when configuring the data source.

The default username and password are admin and admin.

You're all set!

Plugins management

For detailed instructions on how to install plugins on Grafana Cloud or locally, please check out the Plugin management docs.

Configuration

To configure the Quickwit datasource, you need to provide the following information:

• The Quickwit API URL with the /api/v1 suffix. If you have a Quickwit local instance, set the host to http://host.docker.internal:7280/api/v1 on macOS or http://localhost:7280/api/v1 on Linux.
• The index name.
• The timestamp field name.
• The output format of the timestamp field: only unix_timestamp_secs, unix_timestamp_millis, unix_timestamp_micros, unix_timestamp_nanos, iso8601 and rfc3339 are supported.
• The log message field name (optional). This is the field displayed in the explorer view.
• The log level field name (optional). It must be a fast field.

With Grafana UI

Follow these instructions to add a new Quickwit data source, and enter configuration options.

With a configuration file

apiVersion: 1

datasources:
  - name: Quickwit
    type: quickwit-quickwit-datasource
    url: http://localhost:7280/api/v1
    jsonData:
      index: 'hdfs-logs'
      timeField: timestamp
      timeOutputFormat: unix_timestamp_secs
      logMessageField: body
      logLevelField: severity_text

Template variables

Learn more

• Set up alerting; refer to Alerts overview.

Contributing to Quickwit datasource

Details on our contributing guide.