document searcher config request_timeout_secs (#5452)

* document searcher config request_timeout_secs * add some more details to the docs * update url
quickwit-oss · Oct 2, 2024 · 060dfd8 · 060dfd8
1 parent 2dcc696
commit 060dfd8
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 8 deletions.
diff --git a/docs/configuration/node-config.md b/docs/configuration/node-config.md
@@ -199,7 +199,7 @@ This section contains the configuration options for a Searcher.
 | `max_num_concurrent_split_searches` | Maximum number of concurrent split search requests running on a Searcher. | `100` |
 | `max_num_concurrent_split_streams` | Maximum number of concurrent split stream requests running on a Searcher. | `100` |
 | `split_cache` | Searcher split cache configuration options defined in the section below. Cache disabled if unspecified. | |
-
+| `request_timeout_secs` | The time before a search request is cancelled. This should match the timeout of the stack calling into quickwit if there is one set.  | `30` |
 
 ### Searcher split cache configuration
 

diff --git a/docs/get-started/tutorials/trace-analytics-with-grafana.md b/docs/get-started/tutorials/trace-analytics-with-grafana.md
@@ -12,7 +12,9 @@ You only need a few minutes to get Grafana working with Quickwit and build meani
 
 ## Create a Docker Compose recipe
 
-Let's add a [Quickwit instance](../installation.md) with the OTLP service enabled.
+First, create a `docker-compose.yml` file. This file will define the services needed to run Quickwit with OpenTelemetry and Grafana with the Quickwit Datasource plugin.
+
+Below is the complete Docker Compose configuration:
 
 ```yaml
 version: '3.0'
@@ -25,23 +27,21 @@ services:
     ports:
       - 7280:7280
     command: ["run"]
-```
 
-Then we create a [Grafana](https://grafana.com/docs/grafana/latest/setup-grafana/installation/docker/#run-grafana-via-docker-compose) service with the [Quickwit Datasource](https://github.com/quickwit-oss/quickwit-datasource) plugin.
-
-```yaml
   grafana:
     image: grafana/grafana-oss
     container_name: grafana
     ports:
       - "${MAP_HOST_GRAFANA:-127.0.0.1}:3000:3000"
     environment:
-      GF_INSTALL_PLUGINS: https://github.com/quickwit-oss/quickwit-datasource/releases/download/v0.3.1/quickwit-quickwit-datasource-0.3.1.zip;quickwit-quickwit-datasource
+      GF_INSTALL_PLUGINS: https://github.com/quickwit-oss/quickwit-datasource/releases/download/v0.4.6/quickwit-quickwit-datasource-0.4.6.zip;quickwit-quickwit-datasource
       GF_AUTH_DISABLE_LOGIN_FORM: "true"
       GF_AUTH_ANONYMOUS_ENABLED: "true"
       GF_AUTH_ANONYMOUS_ORG_ROLE: Admin
 ```
 
+The default Grafana port is 3000. If this port is already taken, you can modify the port mapping, for example, changing 3000:3000 to 3100:3000 or any other available port.
+
 Save and run the recipe:
 
 ```bash
@@ -99,3 +99,5 @@ Quickwit sends itself its own traces, so you should already have data to display
 Here's what your first dashboard can look like :
 
 ![Quickwit Panel in Grafana Dashboard](../../assets/images/screenshot-grafana-tutorial-dashboard.png)
+
+
diff --git a/docs/reference/metrics.md b/docs/reference/metrics.md
@@ -3,7 +3,7 @@ title: Metrics
 sidebar_position: 70
 ---
 
-Quickwit exposes some key metrics via [Prometheus](https://prometheus.io/). You can use any front-end that supports Prometheus to examine the behavior of Quickwit visually.
+Quickwit exposes key metrics in the [Prometheus](https://prometheus.io/) format on the `/metrics` endpoint. You can use any front-end that supports Prometheus to examine the behavior of Quickwit visually.
 
 ## Cache Metrics