Skip to content

Commit

Permalink
Fix polling interval docs (#4988)
Browse files Browse the repository at this point in the history
* Fix polling conf docs

* Update docs/configuration/metastore-config.md

Co-authored-by: Adrien Guillo <[email protected]>

* Update docs/configuration/metastore-config.md

Co-authored-by: Adrien Guillo <[email protected]>

---------

Co-authored-by: Adrien Guillo <[email protected]>
  • Loading branch information
rdettai and guilload authored May 24, 2024
1 parent be853d1 commit 9b5a8ae
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 12 deletions.
6 changes: 5 additions & 1 deletion docs/configuration/metastore-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,11 @@ By default, the File-Backed Metastore is only read once when you start a Quickwi

You can also configure it to poll the File-Backed Metastore periodically to keep a fresh view of it. This is useful for a Searcher instance that needs to be aware of new splits published by an Indexer running in parallel.

To configure the polling interval (in seconds only), add a URI fragment to the storage URI like this: `s3://quickwit/my-indexes#polling_interval=30s`
To configure the polling interval (in seconds), add a URI fragment to the storage URI as follows: `s3://quickwit/my-indexes#polling_interval=30s`

:::note
The polling interval can be configured in seconds only; other units, such as minutes or hours, are not supported.
:::

:::tip
Amazon S3 charges $0.0004 per 1000 GET requests. Polling a metastore every 30 seconds costs $0.04 per month and index.
Expand Down
12 changes: 1 addition & 11 deletions docs/configuration/node-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -123,17 +123,7 @@ This section may contain one configuration subsection per available metastore im

### File-backed metastore configuration

| Property | Description | Default value |
| --- | --- | --- |
| `polling_interval` | Time interval between successive polling attempts to detect metastore changes. | `30s` |

Example of a metastore configuration for a file-backed implementation in YAML format:

```yaml
metastore:
file:
polling_interval: 1m
```
File-backed metastore doesn't have any node level configuration. You can configure the poll interval [at the index level](./metastore-config.md#polling-configuration).

### PostgreSQL metastore configuration

Expand Down

0 comments on commit 9b5a8ae

Please sign in to comment.