From c7deccb4944702d21c55d3acff15793d3e4ba633 Mon Sep 17 00:00:00 2001 From: Matthew Khouzam Date: Fri, 3 Mar 2023 09:30:29 -0500 Subject: [PATCH 1/2] Update README.md with vision statement Add a vision statement for implementers to understand the underlying logic. --- README.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/README.md b/README.md index 6a87e1e..c12de08 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,17 @@ # trace-server-protocol +The Trace Server Protocol is a protocol designed to allow frontend visualizers to be decoupled from backend. It allows the frontend to query resources in a RESTful way. The guiding principles: + +* Keep things as imutable as possible +* A trace can be queried for any UI elements. +** UI elements can be but should not be limited to charts, graphs, trees and more. +** Filtering on the server side may produce additional UI elements. +** The data type is delivered to the client so the client can remain as lightweight as possible. + +The initial design is base on the Eclipse Trace Compass backend and the theia-trace-extension frontend, however this protocol is agnostic and all changes will be considered and suggestions are welcomed. + +## How it works + Specification of the Trace Server Protocol This protocol is built to decouple the backend and frontend of trace analysers, allowing traces to reside and be analysed on the backend, and visual models to be exchanged with a variety of clients. From d55bfaa000531ce9fbc6b5cdc8c6ed98a063648d Mon Sep 17 00:00:00 2001 From: Matthew Khouzam Date: Fri, 3 Mar 2023 09:37:57 -0500 Subject: [PATCH 2/2] fix formating --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c12de08..4a23cb6 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ The Trace Server Protocol is a protocol designed to allow frontend visualizers t * Keep things as imutable as possible * A trace can be queried for any UI elements. -** UI elements can be but should not be limited to charts, graphs, trees and more. -** Filtering on the server side may produce additional UI elements. -** The data type is delivered to the client so the client can remain as lightweight as possible. + * UI elements can be but should not be limited to charts, graphs, trees and more. + * Filtering on the server side may produce additional UI elements. + * The data type is delivered to the client so the client can remain as lightweight as possible. The initial design is base on the Eclipse Trace Compass backend and the theia-trace-extension frontend, however this protocol is agnostic and all changes will be considered and suggestions are welcomed.