Skip to content

Commit 71563ac

Browse files
aaanhaaanh
committed
Update README formatted and include electronmon
1 parent c2dccba commit 71563ac

File tree

1 file changed

+22
-12
lines changed

1 file changed

+22
-12
lines changed

‎README.md‎

Lines changed: 22 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -148,6 +148,16 @@ Or, run
148148
yarn start:electron
149149
```
150150

151+
Or, for electron app, run with auto-refresh when there is code change
152+
153+
```bash
154+
# install electronmon in global, only need to do it once
155+
npm i -g electronmon
156+
157+
# then, in the repo root
158+
electronmon examples/electron
159+
```
160+
151161
and use the Electron application.
152162

153163
If there are errors that occurred while starting the app, see [Troubleshooting](#troubleshooting) for known issues.
@@ -201,10 +211,10 @@ If the **Trace Viewer** icon is not in the left sidebar, select menu **View** fr
201211
There are a few ways to open traces. The main ones are using the **Open Trace Dialog** or the **File Explorer**. There are still some inconsistencies between them.
202212

203213
| Desired action | via Open Trace Dialog | via File Explorer |
204-
|------------------------------------------------|-----------------------|-------------------|
205-
| Open single CTF trace (folder) | ✓ | ✓ |
206-
| Open folder of CTF traces (create trace group) | ✓ | ✓ |
207-
| Open single file trace (ex. JSON Chrome trace) | | ✓ |
214+
| ---------------------------------------------- | --------------------- | ----------------- |
215+
| Open single CTF trace (folder) | ✓ | ✓ |
216+
| Open folder of CTF traces (create trace group) | ✓ | ✓ |
217+
| Open single file trace (ex. JSON Chrome trace) | | ✓ |
208218

209219
Regardless of the opening method used, if the selection is a folder, the tool will look for traces in **Common Trace Format (CTF)** format, such as **Linux Tracing Toolkit traces (LTTng)** Kernel and UST (Userspace) traces, and open all found CTF traces together under the same timeline. The trace events of each CTF trace will be analyzed in chronological order. With this, several traces can be opened as a group (e.g. LTTng Kernel and UST Traces).
210220

@@ -271,14 +281,14 @@ This section shows detailed information about a selected:
271281

272282
This trace viewer depends on code from several other repos. Sometimes resolving issues in the trace viewer repo requires making changes in these code bases:
273283

274-
| Project | Description | Related issues | Links |
275-
|---------------|----|--------------------------|---|
276-
| [Theia][theia-webpage] | Theia is a framework for making custom IDEs. It provides reusable components (e.g. text editor, terminal) and is extensible. For example, this trace viewer is an extension for Theia-based IDEs. | | [Code][theia-code], [Ecosystem][theia-ecosystem] |
277-
| [Trace Compass][tc-project] | Trace analysis tool and precursor to this trace viewer. | [label:"Trace Compass"][tc-gh-label] | [Dev info][tc-dev-info], [Dev setup][tc-dev-setup] |
278-
| [Trace Compass Server][tc-server] | A reference implementation of a Trace Server. Manages and analyzes trace files and provides this data to the trace viewer over the [Trace Server Protocol (TSP)][tsp]. This Trace Server implementation was originally part of Trace Compass, so it requires the same dev setup. Because a protocol is used for communication (TSP), it is possible to develop alternative Trace Servers that are independent of Trace Compass. | [label:"Trace Server"][tc-server-gh-label] | [Dev setup][tc-dev-setup] (same as Trace Compass), [Code][tci-code] (same repo as Trace Compass incubator) |
279-
| [Trace Server Protocol (TSP)][tsp] | Protocol used by the trace viewer to communicate with the trace server. | [label:"trace server protocol"][tsp-gh-label] | |
280-
| [Client-side Trace Server Protocol implementation][tspc] | A client-side implementation of the Trace Server Protocol. Allows the trace viewer to communicate with the server. | | |
281-
| [Timeline Chart][timeline-chart] | Implements the Gantt charts used in this trace viewer. | [label:timeline-chart][timeline-chart-gh-label] | |
284+
| Project | Description | Related issues | Links |
285+
| -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- | ---------------------------------------------------------------------------------------------------------- |
286+
| [Theia][theia-webpage] | Theia is a framework for making custom IDEs. It provides reusable components (e.g. text editor, terminal) and is extensible. For example, this trace viewer is an extension for Theia-based IDEs. | | [Code][theia-code], [Ecosystem][theia-ecosystem] |
287+
| [Trace Compass][tc-project] | Trace analysis tool and precursor to this trace viewer. | [label:"Trace Compass"][tc-gh-label] | [Dev info][tc-dev-info], [Dev setup][tc-dev-setup] |
288+
| [Trace Compass Server][tc-server] | A reference implementation of a Trace Server. Manages and analyzes trace files and provides this data to the trace viewer over the [Trace Server Protocol (TSP)][tsp]. This Trace Server implementation was originally part of Trace Compass, so it requires the same dev setup. Because a protocol is used for communication (TSP), it is possible to develop alternative Trace Servers that are independent of Trace Compass. | [label:"Trace Server"][tc-server-gh-label] | [Dev setup][tc-dev-setup] (same as Trace Compass), [Code][tci-code] (same repo as Trace Compass incubator) |
289+
| [Trace Server Protocol (TSP)][tsp] | Protocol used by the trace viewer to communicate with the trace server. | [label:"trace server protocol"][tsp-gh-label] | |
290+
| [Client-side Trace Server Protocol implementation][tspc] | A client-side implementation of the Trace Server Protocol. Allows the trace viewer to communicate with the server. | | |
291+
| [Timeline Chart][timeline-chart] | Implements the Gantt charts used in this trace viewer. | [label:timeline-chart][timeline-chart-gh-label] | |
282292

283293
## Troubleshooting
284294

0 commit comments

Comments
 (0)