Koa
Lightrun for Koa¶
To use Lightrun with a Koa 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, e.g.,
node index.js
ornpm 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.
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({ 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 thetsconfig.json
file, set the parameter"sourceMap"
to"true"
. -
From a terminal, run the application.
node index.js