diff --git a/docs/configuration/node-config.md b/docs/configuration/node-config.md index 225c75c2a93..ede3fffeab7 100644 --- a/docs/configuration/node-config.md +++ b/docs/configuration/node-config.md @@ -31,6 +31,7 @@ A commented example is available here: [quickwit.yaml](https://github.com/quickw | `data_dir` | Path to directory where data (tmp data, splits kept for caching purpose) is persisted. This is mostly used in indexing. | `QW_DATA_DIR` | `./qwdata` | | `metastore_uri` | Metastore URI. Can be a local directory or `s3://my-bucket/indexes` or `postgres://username:password@localhost:5432/metastore`. [Learn more about the metastore configuration](metastore-config.md). | `QW_METASTORE_URI` | `{data_dir}/indexes` | | `default_index_root_uri` | Default index root URI that defines the location where index data (splits) is stored. The index URI is built following the scheme: `{default_index_root_uri}/{index-id}` | `QW_DEFAULT_INDEX_ROOT_URI` | `{data_dir}/indexes` | +| environment variable only | Log level of Quickwit. Can be a direct log level, or a comma separated list of `module_name=level` | `RUST_LOG` | `info` | ## REST configuration diff --git a/docs/get-started/quickstart.md b/docs/get-started/quickstart.md index 5c72f327f78..ffa552673f0 100644 --- a/docs/get-started/quickstart.md +++ b/docs/get-started/quickstart.md @@ -62,6 +62,8 @@ docker run --rm -v $(pwd)/qwdata:/quickwit/qwdata -p 127.0.0.1:7280:7280 quickwi +Tips: you can use the environment variable `RUST_LOG` to control quickwit verbosity. + Check it's working by browsing the [UI at http://localhost:7280](http://localhost:7280) or do a simple GET with cURL: ```bash diff --git a/docs/reference/cli.md b/docs/reference/cli.md index 46225eefeae..6b289fb7024 100644 --- a/docs/reference/cli.md +++ b/docs/reference/cli.md @@ -819,28 +819,15 @@ Disables [telemetry](../telemetry.md) when set to any non-empty value. `QW_DISABLE_TELEMETRY=1 quickwit help` - +### RUST_LOG -## Environment Variables +Configure quickwit log level. -### QW_CLUSTER_ENDPOINT - -Specifies the address of the cluster to connect to. Management commands `index`, `split` and `source` require the `cluster_endpoint`, which you can set once and for all with the `QW_CLUSTER_ENDPOINT` environment variable. - -### QW_CONFIG - -Specifies the path to the [quickwit config](../configuration/node-config.md). Commands `run` and `tools` require the `config`, which you can set once and for all with the `QW_CONFIG` environment variable. - -*Example* - -`export QW_CONFIG=config/quickwit.yaml` - -### QW_DISABLE_TELEMETRY - -Disables [telemetry](../telemetry.md) when set to any non-empty value. - -*Example* +*Examples* -`QW_DISABLE_TELEMETRY=1 quickwit help` +``` +# run with higher verbosity +RUST_LOG=debug quickwit run +# run with log level info, except for indexing related logs +RUST_LOG=info,quickwit_indexing=debug quickwit run +```