From d6ba55e626de2fc32898eb46e731a59ebb7cb285 Mon Sep 17 00:00:00 2001 From: Gabriel Fernando Dyck Date: Sun, 16 Feb 2020 01:12:31 -0300 Subject: [PATCH] Add jaeger-ui search configuration jaegertracing/jaeger-ui#511 (#348) * Add jaeger-ui search input documentation Signed-off-by: Gabriel Fernando Dyck * Add search input config detail Signed-off-by: Gabriel Fernando Dyck * Improve documentation for search configuration. Signed-off-by: Gabriel Fernando Dyck * Improve search input limit doc. Signed-off-by: Gabriel Fernando Dyck --- content/docs/next-release/frontend-ui.md | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/content/docs/next-release/frontend-ui.md b/content/docs/next-release/frontend-ui.md index 20897a21..e9612a94 100644 --- a/content/docs/next-release/frontend-ui.md +++ b/content/docs/next-release/frontend-ui.md @@ -12,7 +12,8 @@ Several aspects of the UI can be configured: * The Dependencies section can be enabled / configured * Google Analytics tracking can be enabled / configured * Additional menu options can be added to the global nav - + * Search input limits can be configured + These options can be configured by a JSON configuration file. The `--query.ui-config` command line parameter of the query service must then be set to the path to the JSON file when the query service is started. An example configuration file: @@ -43,6 +44,13 @@ An example configuration file: ] } ], + "search": { + "maxLookback": { + "label": "2 Days", + "value": "2d" + }, + "maxLimit": 1500 + }, "linkPatterns": [{ "type": "process", "key": "jaeger.version", @@ -92,6 +100,17 @@ Links can either be members of the `menu` Array, directly, or they can be groupe The `items` Array should contain one or more link configurations. +### Search Input Limit + +The `search.maxLimit` configures the maximum results that the input let you search. + +The `search.maxLookback` configures the maximum time before the present users can query for traces. The options in the Lookback dropdown greater than this value will not be shown. + +Field | Description +------|------------ +label | The text displayed in the search form dropdown +value | The value submitted in the search query if the label is selected + ### Link Patterns The `linkPatterns` node can be used to create links from fields displayed in the Jaeger UI.