调试器的黑日志处理器
此日志处理器会发送每个条目, 其日志级别为或高于所配置的阈值 作为已配置的 Slack 频道的消息.
安装
npm install --save @debugr/slack
使用量
import { Logger, LogLevel } from '@debugr/core';
import { SlackHandler } from '@debugr/slack';
const globalContext = {
applicationName: 'example',
};
const logger = new Logger(globalContext, [
new SlackHandler({
threshold: LogLevel.FATAL,
webhookUrl: 'your slack webhook url',
}),
]);
logger.fatal('Something failed miserably!');
这个 SlackHandler 构造器接受一个 所需经费 options 对象
以下键作为第一个参数:
| 选项 | 类型 | 默认 | 说明 |
|---|---|---|---|
webhookUrl | string | (必须) | Slack webhook URL; 见 黑 API 文件 如何获得一个. |
threshold | LogLevel | LogLevel.ERROR | 将发布到所配置的频道的最低级别条目 。 此关卡以下的任何条目都将被忽略 . |
channel | string | Slack频道ID 消息应该张贴到. 这只管用 遗留的 Slack 网络呼号。 。 。 . | |
username | string | 消息的用户名应该放在下面。 这只管用 遗留的 Slack 网络呼号。 。 。 . | |
iconUrl | string | 用于替换默认图标的图标的 URL。 这只管用 遗留的 Slack 网络呼号。 。 。 . | |
iconEmoji | string | 用于替换默认图标的 emoji 代码字符串 。 这只管用 遗留的 Slack 网络呼号。 。 。 . | |
errorCallback | (err: Error) => void | (见说明) | 向 Slack 发送消息时会调用回调失败 。 默认的回调会简单地将错误记录入控制台. |
bodyMapper | (entry: LogEntry) => Record<string, any> | (见说明) | 将日志条目映射到要发送到已配置的 Webhook URL的回调 。 有效载荷至少必须包括: text 键为 a string 内容. |