@lite-monitor/node

An event tracking library for Node.js

Table of Contents

• Background
• Installation
• Usage
• Examples
• Related Efforts
• Maintainers
• Contributing
• License

Background

LiteMonitor started with a database online examination real-time monitoring system. During the development of the system, I found that I needed an event tracking library that could meet the following characteristics:

• Lightweight
• Low invasiveness
• Well defined
• Good compatibility

As a result, I built a JavaScript library and published it to npm. In February 2021, I started developing version 1.0 of the project.

Installation

This library uses Node.js and its package manager. Please make sure they are installed locally.

$ npm install @lite-monitor/node

or

$ yarn add @lite-monitor/node

or

$ pnpm add @lite-monitor/node

Usage

This library can be used in CommonJS project and ESM project. Please refer to the Examples.

Examples

For Node.js

import { NodeMonitor } from '@lite-monitor/node';

// Initialize
const monitor = new NodeMonitor();

// Report error event
const error = new Error();
monitor.reportError(error);

For Express

Please refer to the Express Demo.

For Koa

Please refer to the Koa Demo.

Related Efforts

• @lite-monitor/base
• @lite-monitor/web
• Express
• Koa

Maintainers

@peidongxie

Contributing

Feel free to open an issue or PR.

License

MIT © 谢沛东