/theia-trace-extension

Description: Theia trace viewer extension using the tsp-typescript-client (https://github.com/theia-ide/tsp-typescript-client) and Trace Server Protocol (https://github.com/theia-ide/trace-server-protocol).

Primary LanguageTypeScriptMIT LicenseMIT

Gitpod ready-to-code

Trace Viewer extension for Theia applications

Theia trace viewer extension using the tsp-typescript-client (https://github.com/theia-ide/tsp-typescript-client) and Trace Server Protocol (https://github.com/theia-ide/trace-server-protocol).

Prerequisites for running this extension are the same as those for running the theia IDE.

Consume the trace viewer extension from npm

We plan to distribute this extension on npm.

Availability: TBD

Build the extension and example application

Here is the step in order to build the trace viewer

  1. Clone this theia-trace-extension repository
  2. cd theia-trace-extension
  3. Now you are ready to build the application: yarn

Note for some debian-based machines: On some distros, there are 2 yarn commands. If you get an error message saying ERROR: There are no scenarios; must have at least one., you are using the wrong yarn. See yarnpkg/yarn#2821.

Try the trace extension

This repository contains an example trace-viewer application that includes the trace extension. It has two versions:

  • browser: a "browser" application, accessed with a web browser
  • electron: a native desktop application

In order to open traces you need a trace server running on the same machine as the trace extension. You can download the Eclipse Trace Compass server or build it yourself using Trace Compass and the Incubator, take a look at the instruction here.

  1. Start the trace server: ./tracecompass-server
  2. From the repo root: yarn start:browser or yarn start:electron
  3. Go to http://localhost:3000 or use the Electron application

Package the Example Theia Trace Viewer Application

It's possible to package the repo's example application with electron-builder. After running yarn in the repo root, do:

$> cd electron-app $> yarn package

The configured Linux packaging(s) will be generated folder electron-app/dist