lightstep-overlay

An in-browser, development overlay that provides links to real-time tracing data.

Installation

Using the script directly

The lightstep-overlay.min.js file can be downloaded and included in your HTML page directly:

<script src="lightstep-overlay.min.js"></script>

Initializing with a tracer object: the package is exported under the global symbol LightStepOverlay. Call LightStepOverlay.initialize(tracer) to initialize overlay. tracer must be a valid lightstep.Tracer object.

Via NPM:

npm install --save lightstep-overlay

The overlay script will be located in node_modules/dist/lightstep-overlay.min.js. Include the script in your HTML via whatever mechanism works best for your web application.

To initialize the overlay call initialize:

import lightstep from 'lightstep-tracer';
import initializeOverlay from 'lightstep-overlay';
 
let tracer = new lightstep.Tracer(options);
 
// Initialize the overlay
initializeOverlay(tracer);

Using as a module

The source is compiled down to ES5 code in unbundled form into the lib directory. The package.json main entry-point uses this code.