aboutsummaryrefslogtreecommitdiffstats
path: root/client/js
diff options
context:
space:
mode:
authorErlend <erlendniko@hotmail.com>2022-08-08 12:37:23 +0200
committerErlend <erlendniko@hotmail.com>2022-08-08 12:37:23 +0200
commitd14fee177e963e559d9eede67391a15ca8ad87d2 (patch)
tree5e15085aa5e91943ac8bd1cf4359a6ec69c8b233 /client/js
parent2cc3d2edc707c5c5043ffc2654659afbe25f9130 (diff)
Updated README with information about trace visualizer
Diffstat (limited to 'client/js')
-rw-r--r--client/js/app/README.md37
-rw-r--r--client/js/app/img/JaegerExample.pngbin0 -> 24416 bytes
-rw-r--r--client/js/app/img/TraceConverter.pngbin0 -> 14448 bytes
-rw-r--r--client/js/app/img/result.pngbin0 -> 101286 bytes
4 files changed, 36 insertions, 1 deletions
diff --git a/client/js/app/README.md b/client/js/app/README.md
index c3a9e2cac50..7e7aed1b2e1 100644
--- a/client/js/app/README.md
+++ b/client/js/app/README.md
@@ -2,7 +2,42 @@
# Vespa client
-This app is work in progress
+This app is work in progress.
+
+This client 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
+
+To use the visualizer you 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 Vespa traces using _trace.timestampa=true_ **and** _traceLevel_ between 3 and 5 (inclusive) will work correctly.
+
+![Trace Converter](/img/TraceConverter.png)
+
+When downloading the trace a new tab with Jeager will open up.
+Press the _JSON File_ button as shown in the image, and drag and drop the trace you just downloaded.
+
+![Jager Image](/img/JaegerExample.png)
+
+You can then click on the newly added trace and see it displayed as a flame graph.
+
+![Example Image](/img/result.png)
# Client install and start
diff --git a/client/js/app/img/JaegerExample.png b/client/js/app/img/JaegerExample.png
new file mode 100644
index 00000000000..646123962ad
--- /dev/null
+++ b/client/js/app/img/JaegerExample.png
Binary files differ
diff --git a/client/js/app/img/TraceConverter.png b/client/js/app/img/TraceConverter.png
new file mode 100644
index 00000000000..9d7146556a1
--- /dev/null
+++ b/client/js/app/img/TraceConverter.png
Binary files differ
diff --git a/client/js/app/img/result.png b/client/js/app/img/result.png
new file mode 100644
index 00000000000..6f17cc783bb
--- /dev/null
+++ b/client/js/app/img/result.png
Binary files differ