blob: ae6a8d1cc25be63a9a93e9bdb1e123b97c1fa571 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
|
<!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. -->
![Vespa logo](https://vespa.ai/assets/vespa-logo-color.png)
# Vespa client
This app is work in progress.
It currently contains the **Query Builder** and the **Trace Visualizer**.
## Query Builder
The Query Builder is a tool for creating Vespa queries to send to a local backend.
The tool provides all of the options for query parameters from dropdowns.
The input fields provide hints to what is the expected type of value.
## Trace Visualizer
The Trace Visualizer is a tool for converting and visualizing traces from Vespa in a flame graph.
To use the visualizer, a [Jaeger](https://www.jaegertracing.io/) instance must be run locally with Docker:
docker run -d --rm \
-p 16685:16685 \
-p 16686:16686 \
-p 16687:16687 \
-e SPAN_STORAGE_TYPE=memory \
jaegertracing/jaeger-query:latest
The Jaeger UI can then be reached at **localhost:16686/search**
To use the visualizer,
paste the Vespa trace into the text box
and press the button to convert the trace to a format supported by Jaeger and download it.
Only traces using _trace.timestamps=true_ **and** _traceLevel_ between 3 and 5 (inclusive) will work correctly -
see [query tracing](https://docs.vespa.ai/en/query-api.html#query-tracing):
![Trace Converter](img/TraceConverter.png)
After downloading the converted trace, it can be used with the Jaeger UI.
Press the _JSON File_ button as shown in the image, and drag and drop the trace you just downloaded:
![Jaeger Image](img/JaegerExample.png)
Then click on the newly added trace and see it displayed as a flame graph:
![Example Image](img/result.png)
## Client install and start
nvm install --lts node # in case your current node.js is too old
yarn install
yarn dev # then open link, like http://127.0.0.1:3000/
<!-- ToDo: publish a Docker image with all the clients ... -->
|