55 Commits
Author SHA1 Message Date
Luca CominardiandCursor f49ce1ee44 Add global metrics labels env var (#6649)
* Add global metrics labels env var

Co-authored-by: Cursor <cursoragent@cursor.com>

* Name metrics label separators

Co-authored-by: Cursor <cursoragent@cursor.com>

* Rename metrics labels env var constant

Co-authored-by: Cursor <cursoragent@cursor.com>

* Move metrics labels docs to CLI reference

Co-authored-by: Cursor <cursoragent@cursor.com>

* Validate global metrics labels during telemetry startup

Reject malformed label configuration before installing recorders so metrics cannot start with silently incomplete global labels.

Co-authored-by: Cursor <cursoragent@cursor.com>

---------

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-08-03 10:19:13 +00:00
Adrien Guillo a2dd31c1d2 Remove telemetry (#6431)
* Remove telemetry

* Update LICENSE-3rdparty.csv
2026-05-15 10:47:54 -04:00
trinity-1686a dc54c8ed60 support creating index on update if missing (#5773)
* add support for creating missing index on update

* add create-on-update to cli

* add test

* optionally create source on update

* add documentation
2025-06-06 11:03:12 +02:00
Remi Dettai ffd816ba71 Add update source API (#5636) 2025-01-27 18:33:16 -05:00
Remi Dettai 072d0fe7c8 Detailed ingest response (#5635)
* Detailed ingest response

* Fix unit tests

* Change detailed_parse_failures into detailed_response

And other nit improvements.

* Add to cli
2025-01-21 09:38:58 +01:00
Remi Dettai f9a7e68147 Update docs to prepare for 0.9 release (#5605)
* Update docs to prepare for 0.9 release

* Fix typos and minor clarifications
2025-01-13 09:03:52 +00:00
trinity-1686a d142f59b8d add more env var config for postgres (#5365)
* add more env var config for postgres

* add tests for migrations

* add documentation for new environment variables
2024-09-12 13:40:19 +00:00
Remi Dettai b6db60d296 Fix typos all over the codebase (#5259) 2024-07-27 12:08:58 +09:00
Remi Dettai f27198fbd1 Index update from index config (#5078)
* Add indexing_settings and use index config as input

* Doc fixes and cleanup deprecated parameters

* Doc improvments

* Fix outdated IndexMetadata content

* Fix typos in CLI output

* Add metastore tests for each updatable config field

* Address review comments

* Fix unintended privatisation of DocMapping

* Fix typo in tests

* Address review comments
2024-06-12 19:58:38 +00:00
Remi Dettai ec88657994 Index configuration update (#4832)
* Add update endpoint with docs and unit tests

Missing integration test

* Fix unit test

* Cli and integration tests

* Add cli for update

* Improve index config docs

* Fix openapi spec

* Re-hide local-search command

* Fix and improve update endpoint docs

* Small adjustments

* Make update search-settings CLI more forward compatible

* Address all small review comments

* Refactor mutate_index_metadata to use MutationOccured<IndexMetadata>

* Apply new round of PR comments
2024-04-15 12:42:39 +00:00
trinity-1686a 53f38d60cf document RUST_LOG (#4420) 2024-01-24 10:44:59 +00:00
JerryKwanandFrançois Massot fd1547b7df expose rest api for splits (#3942)
* expose rest api for splits

expose rest api for split list
change rest api response data structure
add offset/limit pagniation
change SplitClient list() accordingly

* fix broken test case

fix broken test case

* fix broken test case in index_api

fix broken test case in index_api

* update documents accordingly

update cli.md
update rest-api.md

* Update quickwit/quickwit-serve/src/index_api/rest_handler.rs

Co-authored-by: François Massot <francois.massot@gmail.com>

* fix bug in rest handler

fix bug in rest handler

* code lint

code lint

---------

Co-authored-by: François Massot <francois.massot@gmail.com>
2023-10-25 08:37:25 +08:00
Remi Dettai 926c0f7650 Update S3 tutorial and related docs (#3954)
* Update s3 tutorial after running it again

* Mention time pruning in rest API

* Differentiate commit timeout arg from index config

* Explicit cold vs warm start
2023-10-18 09:03:01 +00:00
Igor Motov 75a41f71ae Reformat common CLI option docs as a table (#3513)
Reformat common CLI option docs as a table to make them consistent with 
auto-generated documentation.

Fixes #3512
2023-06-09 05:12:38 +00:00
Igor Motov 82b4bdf126 Add commit timeout docs (#3477)
Adds the commit timeout documentation.

Fixes #3476
2023-06-06 15:16:26 +09:00
Igor Motov b5947a1247 Improve CLI docs (#3505)
Replaces lists of options with tables in CLI docs.

Fixes #3504
2023-06-06 06:08:49 +00:00
Igor Motov c53ec4fc38 Fix CLI options in the generated documentation (#3475)
Changes the way the options are generated in markdown to make them look
more readable in the browser.

Fixes #3474
2023-06-05 21:43:33 +00:00
Paul Masurel ec3c9b6bf0 Added elasticsearch API reference doc (#3482)
* Added elasticsearch API reference doc

Added rest test.

* Fixing table.
2023-06-05 17:36:59 +09:00
Evance Soumaoro 0ff620d575 Support input-format arg for local-ingest command (#3388)
* added input-format arg to Quickwit local-ingest command

* add docs

* rebase update clap
2023-05-31 19:58:50 +00:00
Evance Soumaoro d9df0e55d6 make size limit for batch configurable on the cli (#3394) 2023-05-25 16:26:37 +00:00
Evance Soumaoro 7dbd3e8c20 Display uncompressed document size in UI (#3345)
* display uncompressed document size in UI

* clarified size of published document (uncompressed)

* renamed size_published_docs to size_published_splits and added size_published_docs_uncompressed

* updated docs and cli
2023-05-22 22:09:47 +00:00
Evance SoumaoroandFrançois Massot 0aaffccdf7 Add "operating quickwit" section in the docs (#2919)
* added doc for qwdata

* rephrased some paragraphs

* Update docs/internals/data-directory.md

Co-authored-by: François Massot <francois.massot@gmail.com>

* Update docs/internals/data-directory.md

Co-authored-by: François Massot <francois.massot@gmail.com>

* Update docs/internals/data-directory.md

Co-authored-by: François Massot <francois.massot@gmail.com>

* Update docs/internals/data-directory.md

Co-authored-by: François Massot <francois.massot@gmail.com>

* fix from pr comments

* Move aws cost docs into operating directory.

* Moving doc content to operating dir.

* Add monitoring doc page and complete local split cache management.

* Complete/clean operating docs.

* Wording.

* Fix links.

---------

Co-authored-by: François Massot <francois.massot@gmail.com>
2023-03-28 12:09:33 +02:00
François Massot 3084339a64 Update CLI doc. (#2949)
* Update CLI doc.

* Add fieldnorm comment for scoring on rest-api doc.
2023-03-06 00:30:18 +01:00
François Massot dbd90a25a3 Replace prettyjson by pretty_json to be consistent everywhere. (#2876) 2023-02-23 17:19:12 +01:00
Evance Soumaoro d789f7cd2c Updated scoring example (#2855)
* updated scoring query example with observable effect

* update cli_doc_ext.toml
2023-02-20 12:32:53 +00:00
François Massot cb6a545496 Update CLI docs with new CLI. (#2791) 2023-02-13 22:15:55 +01:00
boraarslan efafcf7624 Add support for transform with VRL (#2555) 2023-01-20 02:04:13 +00:00
François Massot c1c26b2abb Replace SWIM references by chitchat. (#2601) 2022-12-21 14:07:36 +01:00
François Massot 95fd0fceed Fix doc links. (#2527) 2022-12-01 00:56:23 +01:00
François Massot 21478ead52 Fix doc link. 2022-11-30 22:44:52 +01:00
Evance SoumaoroandFrançois Massot aed23e4f7c Updated CLI doc (#2511)
* updated services doc in cli

* updated cli-doc-generator to support top level command

* added warning on timestamp

Co-authored-by: François Massot <francois.massot@gmail.com>
2022-11-30 19:47:29 +00:00
Evance Soumaoro 8671b79e17 Document timestamp pruning (#2306)
* document timestamp pruning should be in seconds

* rephrased docs
2022-11-14 19:56:20 +00:00
Evance Soumaoro 7031395b8c Update source CLI docs (#2078) 2022-10-21 10:36:14 -04:00
Evance Soumaoro 30bcc0bf4d Support for snippet highlight (#1842)
* implemented snippet extraction on search

* fix comment after self-review

* update tantivy version

* fix comment from PR

* refactored and updated doc for snippet-fields

* fix str trucation
2022-08-24 12:02:52 +00:00
boraarslan 6bbae655e6 Add support for BM25 (#1840) 2022-08-13 11:06:13 +00:00
Adrien Guillo e34f1ecd7c Reorganize docs sidebar 2022-05-12 11:41:09 -04:00
Adrien Guillo 09a62c2aef Generate docs 2022-04-27 09:53:54 -04:00
Dai Dao 2edd45d86e Add quickwit index list command (#1300) 2022-04-19 13:19:17 -04:00
Adrien Guillo a405133fc9 Clear cache unless instructed otherwise (#1280) 2022-04-12 06:03:45 +00:00
Adrien Guillo 9f809cc9f4 Rename clean_cache option to clear-cache and document 2022-04-11 08:00:07 -04:00
Paul Masurel 02e8455c2e Quickwit service run several services (#1163)
Closes #1160
2022-03-28 06:44:43 +00:00
Paul Masurel 7a9a11b1af Bugfix in unit tests and updating the doc. (#1207)
Following #1200
2022-03-21 13:05:55 +09:00
Paul Masurel 8d9a1a1a66 Updating links to point to quickwit-oss (#1113) 2022-01-27 15:38:40 +09:00
PSeitz e4fee7f00b update rest api docs, fix links (#1074)
* update rest api docs

fix links
rename index name to index id

* fix headings

* fix gh link in quickwit config

* fix query language link

* fix caution block
2022-01-11 10:06:12 +01:00
François Massot 3bd0b9271d Remove split describe and extract from doc as it's ready from a user … (#1059)
* Remove split describe and extract from doc as it's ready from a user point of view. Add last examples.

* Fix guides.

* Fix fmt.

* Fix comments to be compatible with docusaurus.

* Fix broken links.
2022-01-11 03:22:42 +01:00
f3969a64a3 Complete CLI docs. (#1029)
* Complete CLI docs.

* Update docs/reference/cli.md

Co-authored-by: PSeitz <PSeitz@users.noreply.github.com>

* Update docs/reference/cli.md

Co-authored-by: PSeitz <PSeitz@users.noreply.github.com>

* Improve CLI wording/examples.

* Update CONTRIBUTING.md

Co-authored-by: Evance Soumaoro <evanxg852000@gmail.com>

* Update docs/reference/cli.md

Co-authored-by: Evance Soumaoro <evanxg852000@gmail.com>

Co-authored-by: PSeitz <PSeitz@users.noreply.github.com>
Co-authored-by: Evance Soumaoro <evanxg852000@gmail.com>
2022-01-10 13:39:05 +00:00
PSeitzandFrançois Massot d313eda21a Update/Generate CLI docs (#984)
* update CLI docs

* extend doc generation from toml

fetch long descriptions and examples from toml
remove unused data-dir parameter

* fallback to normal about

* Remove unused parameters. Extend & Fix Docs

* Extend & Fix Docs

* add note, fix comment

* update generated docs

* update docs

* extend & improve cli docs

* move markdown generation to own file

Co-authored-by: François Massot <francois.massot@gmail.com>
2021-12-31 22:18:52 +01:00
PSeitz 217f7f1cdc rename ENV variables from QUICKWIT_ to QW_ (#970)
closes #965
2021-12-24 08:37:19 +00:00
Paul Masurel 20242f030c Updating the reference doc, removing the reference to num_threads (#468) 2021-08-27 09:10:18 +00:00
Adrien Guillo f29365b62a Improve serve command docs (#356) 2021-08-05 11:38:43 +09:00