# notify

**Repository Path**: tars-node/notify

## Basic Information

- **Project Name**: notify
- **Description**: TARS 框架中用于业务的（告警）消息上报
- **Primary Language**: JavaScript
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2019-09-13
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# @tars/notify

上报业务（框架）消息（告警）至 `TARS` 平台。

## report(message[, id])

将消息上报到平台上，并可以在WEB管理页面上查看到。

* _message_: 消息内容（ __必填__ ）
* _id_: 服务线程（进程）ID， *默认值为 process.pid* 

## notify(message[, level, id])

上报通知信息到平台。

* _message_: 通知内容（ __必填__ ）
* _level_: 通知内容的级别，为 LEVEL 枚举， *默认值为 LEVEL.NOTIFYNORMAL* 
* _id_: 服务线程（进程）ID， *默认值为 process.pid* 

`LEVEL` 枚举中有3项可选：

* _LEVEL.NOTIFYNORMAL_: 正常（默认）
* _LEVEL.NOTIFYWARN_: 警告
* _LEVEL.NOTIFYERROR_: 错误

平台每10分钟对上报的异常进行收敛告警。