Skip to content

Commit decf6bb

Browse files
committed
Update README and docker compose
1 parent 0a73aa1 commit decf6bb

File tree

2 files changed

+28
-38
lines changed

2 files changed

+28
-38
lines changed

README.md

Lines changed: 20 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -28,41 +28,34 @@ Quickwit 0.7 is compatible with 0.3.x versions only.
2828

2929
## Installation
3030

31-
### Download the 0.3.0 for Quickwit 0.7
31+
You can either download the plugin manually and unzip it into the plugin directory or use the env variable `GF_INSTALL_PLUGINS` to install it.
3232

33-
```bash
34-
wget https://github.com/quickwit-oss/quickwit-datasource/releases/download/v0.3.0/quickwit-quickwit-datasource-0.3.0.zip
35-
```
33+
### 0.3.2 for Quickwit 0.7
3634

37-
### Unzip into the plugins directory
35+
Run `grafana-oss` container with the env variable:
3836

3937
```bash
40-
mkdir -p grafana-storage/plugins
41-
unzip quickwit-quickwit-datasource-0.3.0.zip -d grafana-storage/plugins
38+
docker run -p 3000:3000 -e GF_INSTALL_PLUGINS="https://github.com/quickwit-oss/quickwit-datasource/releases/download/v0.3.2/quickwit-quickwit-datasource-0.3.2.zip;quickwit-quickwit-datasource" grafana/grafana-oss run
4239
```
4340

44-
### Download the 0.2.4 for Quickwit 0.6
41+
Or download the plugin manually and start Grafana
4542

4643
```bash
47-
wget https://github.com/quickwit-oss/quickwit-datasource/releases/download/v0.2.4/quickwit-quickwit-datasource-0.2.4.zip
44+
wget https://github.com/quickwit-oss/quickwit-datasource/releases/download/v0.3.2/quickwit-quickwit-datasource-0.3.2.zip
45+
mkdir -p plugins
46+
unzip quickwit-quickwit-datasource-0.3.2.zip -d plugins/quickwit-quickwit-datasource-0.3.2
47+
docker run -p 3000:3000 -e GF_PATHS_PLUGINS=/data/plugins -v ${PWD}/plugins:/data/plugins grafana/grafana-oss run
4848
```
4949

50-
### Unzip into the plugins directory
50+
### 0.2.4 for Quickwit 0.6
5151

52-
```bash
53-
mkdir -p grafana-storage/plugins
54-
unzip quickwit-quickwit-datasource-0.2.4.zip -d grafana-storage/plugins
55-
```
56-
57-
### Start Grafana
5852

5953
```bash
60-
docker run --rm -p 3000:3000 \
61-
-e GF_PLUGINS_ALLOW_LOADING_UNSIGNED_PLUGINS=quickwit-quickwit-datasource \
62-
-v ${PWD}/grafana-storage:/var/lib/grafana \
63-
--name grafana-enterprise grafana/grafana-enterprise
54+
docker run -p 3000:3000 -e GF_INSTALL_PLUGINS="https://github.com/quickwit-oss/quickwit-datasource/releases/download/v0.2.4/quickwit-quickwit-datasource-0.2.4.zip;quickwit-quickwit-datasource" grafana/grafana-oss run
6455
```
6556

57+
## Additional instructions
58+
6659
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.
6760

6861
The default username and password are `admin` and `admin`.
@@ -79,8 +72,6 @@ locally, please check out the [Plugin management docs](https://grafana.com/docs/
7972
To configure the Quickwit datasource, you need to provide the following information:
8073
- 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.
8174
- The index name.
82-
- The timestamp field name.
83-
- 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.
8475
- The log message field name (optional). This is the field displayed in the explorer view.
8576
- The log level field name (optional). It must be a fast field.
8677

@@ -99,17 +90,18 @@ datasources:
9990
url: http://localhost:7280/api/v1
10091
jsonData:
10192
index: 'hdfs-logs'
102-
timeField: timestamp
103-
timeOutputFormat: unix_timestamp_secs
10493
logMessageField: body
10594
logLevelField: severity_text
10695
```
10796
108-
## Template variables
109-
110-
## Learn more
97+
## Features
11198
112-
* Set up alerting; refer to [Alerts overview](https://grafana.com/docs/grafana/latest/alerting/).
99+
- Explore view.
100+
- Dashboard view.
101+
- Template variables.
102+
- Adhoc filters.
103+
- Explore Log Context.
104+
- [Alerting](https://grafana.com/docs/grafana/latest/alerting/).
113105
114106
115107
## Contributing to Quickwit datasource

docker-compose.yaml

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,22 @@
11
version: '3.0'
22

33
services:
4-
jaeger:
5-
image: jaegertracing/jaeger-query:1.51
6-
container_name: 'jaeger-quickwit'
4+
quickwit:
5+
image: quickwit/quickwit:edge
76
environment:
8-
- GRPC_STORAGE_SERVER=host.docker.internal:7281
9-
- SPAN_STORAGE_TYPE=grpc-plugin
10-
ports:
11-
- 16686:16686
12-
extra_hosts:
13-
- "host.docker.internal:host-gateway"
7+
- OTEL_EXPORTER_OTLP_TRACES_ENDPOINT=http://localhost:7281
8+
- QW_ENABLE_OPENTELEMETRY_OTLP_EXPORTER=true
9+
command: ["run"]
1410
networks:
1511
- quickwit
12+
ports:
13+
- 7280:7280/tcp
1614
grafana:
1715
container_name: 'grafana-quickwit-datasource'
1816
build:
1917
context: ./.config
2018
args:
21-
grafana_version: 10.0.1
19+
grafana_version: 10.3.1
2220
ports:
2321
- 3000:3000/tcp
2422
volumes:

0 commit comments

Comments
 (0)