Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add jaeger-ui search configuration jaegertracing/jaeger-ui#511 #348

Merged
merged 4 commits into from
Feb 16, 2020
Merged

Add jaeger-ui search configuration jaegertracing/jaeger-ui#511 #348

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
92843cd
Add jaeger-ui search input documentation
GabrielDyck Jan 16, 2020
05d1c99
Add search input config detail
GabrielDyck Jan 16, 2020
aaac19d
Improve documentation for search configuration.
GabrielDyck Feb 15, 2020
4e1ac90
Improve search input limit doc.
GabrielDyck Feb 16, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion content/docs/next-release/frontend-ui.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 can be configured
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* Search input can be configured
* Search defaults can be configured

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In this case, it isn't a default value, it's the max value that the input(maxLimit and maxLookback) can take.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

then let's change to "search input limits", because we're not configuring "inputs"


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:
Expand Down Expand Up @@ -43,6 +44,13 @@ An example configuration file:
]
}
],
"search": {
"maxLookback": {
"label": "2 Days",
"value": "2d"
},
"maxLimit": 1500
},
"linkPatterns": [{
"type": "process",
"key": "jaeger.version",
Expand Down Expand Up @@ -92,6 +100,11 @@ 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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
### Search Input
### Search Input Limits


`search.maxLookback` allows to define the max look back interval that the ui will show in the select input.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What are the valid values for this?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Mmm, I'm not sure about that. I'll check

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

search.maxLookback configures the maximum time before the present users can query for traces.

Field Description
label The text displayed in the search form dropdown
value The limit used to truncate the lookbackOptions in SearchForm.js, and the value submitted in the search query if the label is selected

Raw for above markdown:

Field | Description
------|------------
label | The text displayed in the search form dropdown
value | The limit used to truncate the `lookbackOptions` in `SearchForm.js`, and the value submitted in the search query if the label is selected

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've just added this. Let me know for any changes.
Thanks a lot @everett980!

`search.maxLimit` allows to define the max limit that the input will let you search.

### Link Patterns

The `linkPatterns` node can be used to create links from fields displayed in the Jaeger UI.
Expand Down