DBAPI

# API异常信息如何实时发送到钉钉

# 背景

  • 对于一些重要的API，开发人员会非常关注API有没有报错，为了方便开发人员第一时间获取错误信息，我们可以使用插件来将API报错实时发送到钉钉群。

  • 接下来我们就来实操如何实现

# 准备工作

# 创建钉钉群

如果已有钉钉群，可以跳过此步骤，直接进入下一步。

# 获取群机器人的webhook

注意以下步骤要在PC端钉钉操作

  • 打开钉钉群，点击右上角的群设置

  • 点击群管理-机器人

  • 点击添加机器人

  • 选择自定义

  • 点击添加

  • 填写机器人名字，可以任意填写

  • 勾选自定义关键词，并填写DBAPI

  • 勾选我已阅读并同意，点击完成

  • 将webhook地址复制出来妥善保存，后面会使用，然后点击完成

# 插件配置

# 安装插件

  • 将下载后的jar包存到DBAPI安装目录下的extlib目录下
  • 修改DBAPI安装目录下的conf/plugin.properties文件，添加如下配置，注意填写的地址就是上面准备工作中获取的webhook地址
DingTalkAlarmPlugin.WEBHOOK_URL=https://oapi.dingtalk.com/robot/send?access_token=xxxxxxx
  • 重启DBAPI服务使插件生效
  • 修改API，全局插件-告警中选择钉钉告警插件，并保存API即可对API生效

# 总结

详细请阅读插件文档 (opens new window)