You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Add documentation for previously undocumented Jaeger UI configuration options
in the Frontend/UI Configuration page.
## New Sections Added
### Themes (Dark Mode)
- Document `themes.enabled` for enabling the light/dark theme toggle
- Explains theme persistence in local storage and system preference fallback
### Critical Path
- Document `criticalPathEnabled` for trace view critical path visualization
### Top Tag Prefixes
- Document `topTagPrefixes` for prioritizing important span tags
### Trace Graph
- Document `traceGraph.layoutManagerMemory` for GraphViz memory control
### UI Controls
- Document `disableFileUploadControl` for disabling trace file uploads
- Document `disableJsonView` for disabling JSON view
- Document `forbidNewPage` for preventing new tab/window opens
## Enhanced Existing Sections
### Monitor
- Added `monitor.docsLink` for SPM documentation links
- Added `monitor.emptyState` for customizing empty state display
## Other Changes
- Updated example JSON config to include new options
- Expanded configuration overview list with new capabilities
Relates to: jaegertracing/jaeger-ui#3243
Signed-off-by: Jonah Kowall <[email protected]>
Copy file name to clipboardExpand all lines: content/docs/v2/_dev/deployment/frontend-ui.md
+99-1Lines changed: 99 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,11 +10,15 @@ weight: 7
10
10
11
11
Several aspects of the UI can be configured:
12
12
13
+
* Themes can be enabled to allow switching between light and dark modes
13
14
* The Dependencies section can be enabled / configured
14
15
* The [Monitor tab (aka: Service Performance Monitoring)](../../architecture/spm/) can be enabled / configured
15
16
* App analytics tracking can be enabled / configured (via Google Analytics or custom plugin)
16
17
* Additional menu options can be added to the global nav
17
18
* Search input limits can be configured
19
+
* Critical path visualization can be enabled
20
+
* Tag display priorities can be configured
21
+
* Various UI controls can be disabled for embedding scenarios
18
22
19
23
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.
20
24
@@ -29,6 +33,9 @@ An example configuration file (see [complete schema here](https://github.com/jae
29
33
"monitor": {
30
34
"menuEnabled": true
31
35
},
36
+
"themes": {
37
+
"enabled": true
38
+
},
32
39
"archiveEnabled": true,
33
40
"tracking": {
34
41
"gaID": "UA-000000-2",
@@ -73,10 +80,28 @@ An example configuration file (see [complete schema here](https://github.com/jae
"text": "Redirect to kibana to view log with formatted dates"
75
82
}],
76
-
"traceIdDisplayLength": 20
83
+
"traceIdDisplayLength": 20,
84
+
"criticalPathEnabled": true,
85
+
"topTagPrefixes": ["http.", "db."]
77
86
}
78
87
```
79
88
89
+
### Themes (Dark Mode)
90
+
91
+
Enable the theme toggle button in the navigation bar to allow users to switch between light and dark modes:
92
+
93
+
```json
94
+
{
95
+
"themes": {
96
+
"enabled": true
97
+
}
98
+
}
99
+
```
100
+
101
+
When enabled, users can toggle between light and dark themes using a button in the top navigation. The selected theme is persisted in the browser's local storage. If no theme is stored, the UI respects the user's system preference (`prefers-color-scheme`).
102
+
103
+
`themes.enabled` enables (`true`) or disables (`false`) the theme toggle button. Default: `false`.
104
+
80
105
### Dependencies
81
106
82
107
`dependencies.dagMaxNumServices` defines the maximum number of services allowed before the DAG dependency view is disabled. Default: `200`.
@@ -87,6 +112,29 @@ An example configuration file (see [complete schema here](https://github.com/jae
87
112
88
113
`monitor.menuEnabled` enables (`true`) or disables (`false`) the Monitor menu button. Default: `false`.
89
114
115
+
`monitor.docsLink` specifies a URL to documentation about Service Performance Monitoring. When set, a help link is displayed in the Monitor tab.
116
+
117
+
`monitor.emptyState` allows customizing the empty state display when no monitoring data is available:
`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.
@@ -205,6 +253,56 @@ Field | Description
205
253
206
254
This will display trace IDs like: `1a2b3c4d5e6f` (instead of the full 32-character ID or default 7-character).
207
255
256
+
### Critical Path
257
+
258
+
`criticalPathEnabled` enables (`true`) or disables (`false`) the critical path visualization in the trace view. When enabled, the critical path of each span is highlighted, showing which operations are on the critical path of the overall trace duration. Default: `false`.
259
+
260
+
```json
261
+
{
262
+
"criticalPathEnabled": true
263
+
}
264
+
```
265
+
266
+
### Top Tag Prefixes
267
+
268
+
`topTagPrefixes` defines a set of prefixes for span tag names that are considered "important" and cause the matching tags to appear higher in the list of tags. For example, setting `topTagPrefixes` to `["http."]` would cause all span tags that begin with "http." to be shown above all other tags.
269
+
270
+
```json
271
+
{
272
+
"topTagPrefixes": ["http.", "db.", "rpc."]
273
+
}
274
+
```
275
+
276
+
### Trace Graph
277
+
278
+
`traceGraph.layoutManagerMemory` controls the total memory available for the GraphViz Emscripten module instance used to render trace graphs. The value should be a power of two. The default of 16MB should be sufficient for most cases — only consider using a larger number if you run into the error "Cannot enlarge memory arrays".
279
+
280
+
```json
281
+
{
282
+
"traceGraph": {
283
+
"layoutManagerMemory": 33554432
284
+
}
285
+
}
286
+
```
287
+
288
+
### UI Controls
289
+
290
+
Several options allow disabling specific UI controls, which is useful for embedding scenarios or restricting functionality:
291
+
292
+
`disableFileUploadControl` disables (`true`) or enables (`false`) the file upload control for loading trace JSON files. Default: `false`.
293
+
294
+
`disableJsonView` disables (`true`) or enables (`false`) the JSON view option in the trace view. Default: `false`.
295
+
296
+
`forbidNewPage` when set to `true`, alters all link targets to prevent opening new browser tabs/windows. This is useful when embedding the UI in another application. Default: `false`.
297
+
298
+
```json
299
+
{
300
+
"disableFileUploadControl": true,
301
+
"disableJsonView": true,
302
+
"forbidNewPage": true
303
+
}
304
+
```
305
+
208
306
## Embedded Mode
209
307
210
308
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.
0 commit comments