Skip to content

Commit 46fa8c1

Browse files
committed
Add ADR about adding support for Flame Graph in TSP and trace viewer
Signed-off-by: Bernd Hufmann <bernd.hufmann@ericsson.com>
1 parent d1158b0 commit 46fa8c1

File tree

1 file changed

+6
-5
lines changed

1 file changed

+6
-5
lines changed

doc/adr/0013-flame-graph-support.md

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,8 @@ There are 2 possibilites to support the flame graph in the TSP.
2222

2323
The view itself is very similar to data providers of type `TIME_GRAPH`. The main difference is that the x-axis is the duration and not time. The Trace Compass back-end currently has such a data provider available with the same API than `TIME_GRAPH` data providers. However, this data provider is not exposed to the server through the `getDescriptor()` method of the corresponing data provider factory. It will need a new type to be added to the `ProviderType` enum.
2424

25-
With this solution similar endpoints can be defined which have the advantage that the endpoints and data structures are known. Back-end filtering and highlighting would be supported out of the box. Assuming the new `Provider Type` is called `gantt` the following endpoints will be defined:
25+
With this solution the existing endpoint `TIME_GRAPH` endpoint and be agumented or similar endpoints can be defined which have the advantage that the endpoints and data structures are known. Back-end filtering and highlighting would be supported out of the box.
26+
Assuming the `Provider Type` re-uses `timegraph` the endpoints for the flame graph will be as below:
2627

2728
```
2829
POST /experiments/{expUUID}/outputs/{outputId}/styles
@@ -34,14 +35,14 @@ With this solution similar endpoints can be defined which have the advantage tha
3435
POST /experiments/{expUUID}/outputs/{outputId}/annotations
3536
Get list of annotation for a given annotation categories for this view
3637
37-
POST /experiments/{expUUID}/outputs/gantt/{outputId}/tree
38+
POST /experiments/{expUUID}/outputs/timegraph/{outputId}/tree
3839
Returns the gantt chart entry model
3940
40-
POST /experiments/{expUUID}/outputs/gantt/{outputId}/states
41+
POST /experiments/{expUUID}/outputs/timegraph/{outputId}/states
4142
Returns the states from the for given entries
4243
43-
POST /experiments/{expUUID}/outputs/gantt/{outputId}/tooltip
44-
Get detailed information of a state, annotation or arrow
44+
POST /experiments/{expUUID}/outputs/timegraph/{outputId}/tooltip
45+
Get detailed information of a state or annotation
4546
```
4647

4748
**Note**:

0 commit comments

Comments
 (0)