Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md with vision statement #89

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Update README.md with vision statement #89

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c7deccb
Update README.md with vision statement
MatthewKhouzam Mar 3, 2023
d55bfaa
fix formating
MatthewKhouzam Mar 3, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# trace-server-protocol
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Commit message(s) and PR header are missing a Signed-off-by footer.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Addendum: commit message's body line needs a wrap to max 72 chars, per guideline.


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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure about the RESTful way,

  • as TSP currently bundles a lot of request payload into the body.
  • Recent cross-team discussions also highlighted the current limitations in terms of resource/entity modeling, starting at the request URI level.
  • We also mentioned the domain language which could improve from an ubiquity perspective.
  • All in all, this README may mention the REST/http basis of TSP, without claiming REST-fullness, I think.


* Keep things as imutable as possible
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

immutable

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

as possible.

* A trace can be queried for any UI elements.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

any UI element.

* UI elements can be but should not be limited to charts, graphs, trees and more.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Markdownlint has issues with this reformatted line and the few ones below (8 and 9).

* 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The second commit should be squashed into the first/base one, here in this specific case.


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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is based on


## 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.
Expand Down