@acteam-it/log-adapter-nodejs 中文文档教程

Question

NodeJS Adapter

NodeJS 适配器跟踪 NodeJS 应用程序中的错误并将它们报告给 ACTEAMLOG 服务。 准确的详细信息可帮助您追踪并修复根本原因。

Usage

使用 npm i @acteam-it/log-adapter-nodejs --save

const acteamlog = require('@acteam-it/log-adapter-nodejs');**

Configuration

安装适配器 在服务器顶部需要适配器并将配置传递给 init 函数. 以下选项可用。

Ticket

机票是唯一的强制性信息。 每个服务都有一张唯一的票，所有用这张票发送的事件都将附加到相应的服务。

const acteamlog = require('@acteam-it/log-adapter-nodejs');

acteamlog.init({ ticket: '5BD98E1E607Z1EEB0CBF02374DEA9B5A835DF2ADD3910F7250'});

Badges

徽章包含将附加到报告的错误的个人信息。 徽章必须是字符串类型。 徽章的键最多可以有 100 个字符，而值最多可以有 200 个字符。 如果超出这些限制，则不会处理该事件。 ```节点 acteamlog.init({ 票：'5BD98E1E607Z1EEB0CBF02374DEA9B5A835DF2ADD3910F7250'， 徽章：{ 集群：'欧盟'， serverId: process.env.SERVER_ID } });

### Endpoint
Set the ```endpoint``` property to connect to your individual ACTEAMLOG instance at a given address. Please notice that the ```endpoint``` property will be preferred to the ```instance``` property.

节点 acteamlog.init({ 端点：'http://url:port'， 票：'5BD98E1E607Z1EEB0CBF02374DEA9B5A835DF2ADD3910F7250' });

### Db file
Set the ```dbfile``` property to store events in json local file when endpoint can not be reached.
When an error is catch, if endpoint can be reached then all events stored in this file are send.

节点 acteamlog.init({ 端点：'http://url:port'， 票：'5BD98E1E607Z1EEB0CBF02374DEA9B5A835DF2ADD3910F7250'， dbfile: 'db.json' });

### Secret
Set the ```secret``` property in order to encrypt data in AES 256, between adapter and ```endpoint```.
The ```secret``` default value is ```NFd6N3v1nbL47FK0xpZjxZ7NY4fYpNYd``` you must change it.

节点 acteamlog.init({ 端点：'http://url:port'， 票：'5BD98E1E607Z1EEB0CBF02374DEA9B5A835DF2ADD3910F7250'， dbfile: 'db.json', 秘密：'secretSentence' });

## Verifying setup
To test if everything works you can just try to execute an undefined function like so.

节点 acteamlog.init({ 实例：'演示'， 票：'5BD98E1E607Z1EEB0CBF02374DEA9B5A835DF2ADD3910F7250' });

测试（）;

## Middleware
If you are using Express, you can also add the ACTEAMLOG middleware at the end of your routes.

节点 app.use(acteamlog.errorHandler);

The middleware will send all errors to ACTEAMLOG before passing them to the next middleware.

## Emit errors manually
You can also emit errors manually by passing an error instance to the ```emitError``` method. This is handy for building your own error handling logic.

节点 尝试 { const 结果 = 10 * 数字； } 赶上（错误）{ acteamlog.emitError（错误）； }

### On the fly badges
You can also add dynamic badges to a specific error if you want to provide additional information. This can be useful if you, for example, want to identify the user, who is affected by the error.

节点 尝试 { const 结果 = 10 * 数字； } 赶上（错误）{ acteamlog.emitError(error, { user: req.user.id }); } ```