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
Copy file name to clipboardexpand all lines: docs/deployment.md
+54
Original file line number
Diff line number
Diff line change
@@ -129,6 +129,60 @@ Port | Protocol | Function
129
129
----- | ------- | ---
130
130
16686 | HTTP | **/api/*** endpoints and Jaeger UI at **/**
131
131
132
+
### UI Configuration
133
+
134
+
Two aspects of the UI can be configured:
135
+
136
+
* The top-right menu in the global nav
137
+
* A Google Analytics ID can be defined to enable Google Analytics tracking in the UI
138
+
139
+
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.
140
+
141
+
An example configuration file:
142
+
143
+
```json
144
+
{
145
+
"gaTrackingID": " UA-000000-2",
146
+
"menu": [
147
+
{
148
+
"label": "About Jaeger",
149
+
"items": [
150
+
{
151
+
"label": "GitHub",
152
+
"url": "https://github.com/jaegertracing/jaeger"
153
+
},
154
+
{
155
+
"label": "Docs",
156
+
"url": "http://jaeger.readthedocs.io/en/latest/"
157
+
}
158
+
]
159
+
}
160
+
]
161
+
}
162
+
```
163
+
164
+
In the above example, `gaTrackingID` will be used as the Google Analytics tracking ID and `menu` configures the menu in the top right of the UI.
165
+
166
+
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:
167
+
168
+
```json
169
+
{
170
+
"label": "Some text here",
171
+
"url": "https://example.com"
172
+
}
173
+
```
174
+
175
+
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:
176
+
177
+
```json
178
+
{
179
+
"label": "Dropdown button",
180
+
"items": [ ]
181
+
}
182
+
```
183
+
184
+
The `items` Array should contain one or more link configurations.
185
+
132
186
TODO: Swagger and GraphQL API ([issue 158](https://github.com/uber/jaeger/issues/158)).
0 commit comments