diff options
| author | Erlend <erlendniko@hotmail.com> | 2022-08-11 13:24:41 +0200 |
|---|---|---|
| committer | Erlend <erlendniko@hotmail.com> | 2022-08-11 13:24:41 +0200 |
| commit | 5d94611148044c32ef24408ee6935ab2ce664e82 (patch) | |
| tree | e18f34065ca51ed2ea3c5e6adf90118e967ddb01 /client/js | |
| parent | a3db1c61f4da93b024eba736d22dffef66d66afe (diff) | |
| parent | acfbe53b1c03d7dcdc2d6947970de8d351ae8059 (diff) | |
Merge remote-tracking branch 'upstream/master'
Diffstat (limited to 'client/js')
| -rw-r--r-- | client/js/app/README.md | 51 |
1 files changed, 30 insertions, 21 deletions
diff --git a/client/js/app/README.md b/client/js/app/README.md index 99271629edf..ae6a8d1cc25 100644 --- a/client/js/app/README.md +++ b/client/js/app/README.md @@ -1,48 +1,57 @@ <!-- Copyright Yahoo. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root. --> + + # Vespa client This app is work in progress. +It currently contains the **Query Builder** and the **Trace Visualizer**. + -This client currently contains the **Query Builder** and the **Trace Visualizer**. -# Query Builder +## 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. -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. +## 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 + -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 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. +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):  -After downloading the converted trace is 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. +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: - + -You can then click on the newly added trace and see it displayed as a flame graph. +Then click on the newly added trace and see it displayed as a flame graph:  -# Client install and start + + +## 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 ... --> |