Express

Lightrun for Express¶

To use Lightrun with a Express application:

In your project's folder, install the node agent by running npm install lightrun.
Import Lightrun at the start of your application file (for example, app.js) by adding the following code:
```
require('lightrun').start({
     lightrunSecret: '<LIGHTRUN_SECRET>'
});
```
Run the application as you normally would; for example, node index.js or npm start.

Getting Company Details

To get your <LIGHTRUN_SECRET> key, log into the Management Portal and inspect the Set Up An Agent section, under Getting Started.

Important

Lightrun for TypeScript requires sourcemap files to be included on the server where the production software is deployed.

Instructions

Insert the following code at the start of your application file (for example, index.ts or app.ts).
```
import * as lightrun from 'lightrun';

lightrun.start({
    lightrunSecret: '<LIGHTRUN_SECRET>',
    filename: <full_path_to_metadata_file>
});
```
Info

The filename parameter is optional. See here for details on constructing the metadata file.
In the compilerOptions section of the tsconfig.json file, set the parameter "sourceMap" to "true".
From a terminal, run the application.
```
node index.js
```

Last update: February 7, 2023