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({ company: '<YOUR_COMPANY_NAME>', lightrunSecret: '<YOUR_COMPANY_SECRET>', });
-
Run the application as you normally would; for example,
node index.js
ornpm start
.
Getting Company Details
You can get <YOUR_COMPANY_NAME>
and <YOUR_COMPANY_SECRET>
by logging into the the Management Portal and looking inside the Download the Agent section.
Running the agent in TypeScript applications¶
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
orapp.ts
).import * as lightrun from 'lightrun'; lightrun.start({ company: '<COMPANY-NAME>', lightrunSecret: '<COMPANY-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 thetsconfig.json
file, set the parameter"sourceMap"
to"true"
. -
From a terminal, run the application.
node index.js