-
Notifications
You must be signed in to change notification settings - Fork 158
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Add UI docs Signed-off-by: Alberto Gutierrez <aljesusg@gmail.com> * Rename to Frontend/UI Signed-off-by: Alberto Gutierrez <aljesusg@gmail.com> * Comments addresed Signed-off-by: Alberto Gutierrez <aljesusg@gmail.com> * Crop header in img Signed-off-by: Alberto Gutierrez <aljesusg@gmail.com> * Moved frontend ui docs to deployment section Signed-off-by: Alberto Gutierrez <aljesusg@gmail.com> * rename title to query service & ui Signed-off-by: Alberto Gutierrez <aljesusg@gmail.com> * comments addresed Signed-off-by: Alberto Gutierrez <aljesusg@gmail.com> * Rearrange the docs, fix formatting Signed-off-by: Yuri Shkuro <ys@uber.com>
- Loading branch information
1 parent
89128fb
commit eb3e259
Showing
20 changed files
with
202 additions
and
74 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,196 @@ | ||
--- | ||
title: Frontend/UI | ||
hasparent: true | ||
weight: 10 | ||
--- | ||
|
||
## Configuration | ||
|
||
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 | ||
|
||
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: | ||
|
||
```json | ||
{ | ||
"dependencies": { | ||
"dagMaxNumServices": 200, | ||
"menuEnabled": true | ||
}, | ||
"archiveEnabled": true, | ||
"tracking": { | ||
"gaID": "UA-000000-2", | ||
"trackErrors": true | ||
}, | ||
"menu": [ | ||
{ | ||
"label": "About Jaeger", | ||
"items": [ | ||
{ | ||
"label": "GitHub", | ||
"url": "https://github.com/jaegertracing/jaeger" | ||
}, | ||
{ | ||
"label": "Docs", | ||
"url": "http://jaeger.readthedocs.io/en/latest/" | ||
} | ||
] | ||
} | ||
] | ||
} | ||
``` | ||
|
||
`dependencies.dagMaxNumServices` defines the maximum number of services allowed before the DAG dependency view is disabled. Default: `200`. | ||
|
||
`dependencies.menuEnabled` enables (`true`) or disables (`false`) the dependencies menu button. Default: `true`. | ||
|
||
`archiveEnabled` enables (`true`) or disables (`false`) the archive traces button. Default: `false`. It requires a configuration of an archive storage in Query service. Archived traces are only accessible directly by ID, they are not searchable. | ||
|
||
`tracking.gaID` defines the Google Analytics tracking ID. This is required for Google Analytics tracking, and setting it to a non-`null` value enables Google Analytics tracking. Default: `null`. | ||
|
||
`tracking.trackErrors` enables (`true`) or disables (`false`) error tracking via Google Analytics. Errors can only be tracked if a valid Google Analytics ID is provided. For additional details on error tracking via Google Analytics see the [tracking README](https://github.com/jaegertracing/jaeger-ui/blob/c622330546afc1be59a42f874bcc1c2fadf7e69a/src/utils/tracking/README.md) in the UI repo. Default: `true`. | ||
|
||
`menu` allows additional links to be added to the global nav. The additional links are right-aligned. | ||
|
||
In the sample JSON config above, the configured menu will have a dropdown labeled "About Jaeger" with sub-options for "GitHub" and "Docs". The format for a link in the top right menu is as follows: | ||
|
||
```json | ||
{ | ||
"label": "Some text here", | ||
"url": "https://example.com" | ||
} | ||
``` | ||
|
||
Links can either be members of the `menu` Array, directly, or they can be grouped into a dropdown menu option. The format for a group of links is: | ||
|
||
```json | ||
{ | ||
"label": "Dropdown button", | ||
"items": [ ] | ||
} | ||
``` | ||
|
||
The `items` Array should contain one or more link configurations. | ||
|
||
## Embedded Mode | ||
|
||
Starting with version 1.9, Jaeger UI provides an "embedded" layout mode which is intended to support integrating Jaeger UI into other applications. Currently (as of `v0`), the approach taken is to remove various UI elements from the page to make the UI better suited for space-constrained layouts. | ||
|
||
The embedded mode is induced and configured via URL query parameters. | ||
|
||
To enter embedded mode, the `uiEmbed=v0` query parameter and value must be added to the URL. For example, the following URL will show the trace with ID `abc123` in embedded mode: | ||
|
||
``` | ||
http://localhost:16686/trace/abc123?uiEmbed=v0 | ||
``` | ||
|
||
`uiEmbed=v0` is required. | ||
|
||
Further, each page supported has an <img src="/img/frontend-ui/embed-open-icon.png" style="width: 20px; height:20px;display:inline;" alt="Embed open window"> button added that will open the non-embedded page in a new tab. | ||
|
||
The following pages support embedded mode: | ||
|
||
* Search Page | ||
* Trace Page | ||
|
||
### Search Page | ||
|
||
To integrate the Search Trace Page to our application we have to indicate to the Jaeger UI that we want to use the embed mode with `uiEmbed=v0`. | ||
|
||
For example: | ||
|
||
``` | ||
http://localhost:16686/search? | ||
service=my-service& | ||
start=1543917759557000& | ||
end=1543921359557000& | ||
limit=20& | ||
lookback=1h& | ||
maxDuration& | ||
minDuration& | ||
uiEmbed=v0 | ||
``` | ||
|
||
![Embed Search Traces](/img/frontend-ui/embed-search-traces.png) | ||
|
||
#### Configuration options | ||
|
||
The following query parameter can be used to configure the layout of the search page : | ||
|
||
* `uiSearchHideGraph=1` - disables the display of the scatter plot above the search results | ||
|
||
``` | ||
http://localhost:16686/search? | ||
service=my-service& | ||
start=1543917759557000& | ||
end=1543921359557000& | ||
limit=20& | ||
lookback=1h& | ||
maxDuration& | ||
minDuration& | ||
uiEmbed=v0& | ||
uiSearchHideGraph=1 | ||
``` | ||
|
||
![Embed Search Traces without Graph](/img/frontend-ui/embed-search-traces-hide-graph.png) | ||
|
||
### Trace Page | ||
|
||
|
||
To integrate the Trace Page to our application we have to indicate to the Jaeger UI that we want to use the embed mode with `uiEmbed=v0`. | ||
|
||
For example: | ||
|
||
```sh | ||
http://localhost:16686/trace/{trace-id}?uiEmbed=v0 | ||
``` | ||
![Embed Trace view](/img/frontend-ui/embed-trace-view.png) | ||
|
||
If we have navigated to this view from the search traces page we'll have a button to go back to the results page. | ||
|
||
![Embed Trace view](/img/frontend-ui/embed-trace-view-with-back-button.png) | ||
|
||
#### Configuration options | ||
|
||
The following query parameters can be used to configure the layout of the trace page : | ||
|
||
* `uiTimelineCollapseTitle=1` causes the trace header to start out collapsed, which hides the summary and the minimap. | ||
|
||
``` | ||
http://localhost:16686/trace/{trace-id}? | ||
uiEmbed=v0& | ||
uiTimelineCollapseTitle=1 | ||
``` | ||
![Embed Trace view](/img/frontend-ui/embed-trace-view-with-collapse.png) | ||
|
||
* `uiTimelineHideMinimap=1` removes the minimap, entirely, regardless of whether the trace header is expanded or not. | ||
|
||
``` | ||
http://localhost:16686/trace/{trace-id}? | ||
uiEmbed=v0& | ||
uiTimelineHideMinimap=1 | ||
``` | ||
![Embed Trace view](/img/frontend-ui/embed-trace-view-with-hide-minimap.png) | ||
|
||
* `uiTimelineHideSummary=1` - removes the trace summary information (number of services, etc.) entirely, regardless of whether the trace header is expanded or not. | ||
|
||
``` | ||
http://localhost:16686/trace/{trace-id}? | ||
uiEmbed=v0& | ||
uiTimelineHideSummary=1 | ||
``` | ||
![Embed Trace view](/img/frontend-ui/embed-trace-view-with-hide-summary.png) | ||
|
||
We can also combine the options: | ||
``` | ||
http://localhost:16686/trace/{trace-id}? | ||
uiEmbed=v0& | ||
uiTimelineHideMinimap=1& | ||
uiTimelineHideSummary=1 | ||
``` | ||
![Embed Trace view](/img/frontend-ui/embed-trace-view-with-hide-details-and-hide-minimap.png) |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+251 KB
public/img/frontend-ui/embed-trace-view-with-hide-details-and-hide-minimap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+251 KB
static/img/frontend-ui/embed-trace-view-with-hide-details-and-hide-minimap.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.