Package Exports

lightrun

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (lightrun) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Node.js Lightrun Debugger Agent

Runtime debugger agent for Node.js 10 and above.

Build And Installation

In order to compile the agent you can use - npm install To pack the agent you can run - ./build.sh. This will compile the agent, run tests and pack it to a tgz file. If you do not wish to run the tests, run ./build.sh --skiptests=true

To install the agent, take the built tgz file, copy it to the project you wish to install it in, and run npm install lightrun-*.tgz.

To run the tests, run ./run_all_tests.sh

To run the linter (and have it fix what it can), run npm run fix

Usage

After installing the agent, you can add it to your application by adding a require statement and starting the agent:

require('lightrun').start({company: '<Company name>', lightrunSecret: '<Company secret>'});

Additional configuration options are available to pass to the start call, such as:

noCheckCertificate - Pass true to disable certificate pinning
apiEndpoint - The server endpoint the agent will communicate with
caPath - Path to pem file of the CA signing the certificate of the server (useful for self-signed certificates)

Environment Variables

The agent supports some environment variables for configuration as well:

LIGHTRUN_SECRET - The company secret
LIGHTRUN_COMPANY - The company name
LIGHTRUN_TAGS - Comma separated list of tags for the agent
LIGHTRUN_METADATA_FILE - Path to file containing the metadata json for the agent