npm 包 hubot-datadog-plus 使用教程-JavaScript中文网-JavaScript教程资源分享门户

前言

hubot-datadog-plus 是一个使用 NodeJS 编写的 npm 包，它可以让使用 Hubot 的用户在集成 Datadog 监控平台时更加便捷。本文将详细介绍 hubot-datadog-plus 的安装、配置和使用，并附带示例代码。

安装

使用 npm 包管理器，执行以下命令进行安装：

npm install hubot-datadog-plus

安装完成后，你需要将 hubot-datadog-plus 添加到你的 Hubot 机器人中。这可以通过添加以下内容到你的 scripts 文件中来完成：

module.exports = function(robot) {
  require('hubot-datadog-plus')(robot);
}

配置

hubot-datadog-plus 支持在配置文件中设置以下内容：

Configuration	Description	Type	Default
`DD_API_KEY`	API key used to authenticate to the Datadog API	String	`null`
`DD_APP_KEY`	Application key used to authenticate to the Datadog API	String	`null`
`DD_EVENT_TITLE_TEMPLATE`	Handlebars template used to set the event title	String	`{{level}}: {{message}} in {{room}}`
`DD_EVENT_TAGS`	Tag list to append to each event	Array of Strings	`[]`
`DD_HOST`	Hostname to attach to the event	String	`os.hostname()`
`DD_LEVEL`	Default event level	String	`error`
`DD_MESSAGE_TEMPLATE`	Handlebars template used to set the event message	String	`{{message}} from {{room}} by {{user}}`
`DD_SITE`	Datadog site to use	String	`datadoghq.com`

建议使用直接在环境变量中设置这些值的方式，比如在 .bashrc 或者 .bash_profile 文件中添加以下内容：

export DD_API_KEY=your_api_key
export DD_APP_KEY=your_app_key
export DD_EVENT_TITLE_TEMPLATE='{{level}}: {{message}} in {{room}}'
export DD_EVENT_TAGS='["hubot", "monitoring"]'
export DD_HOST=`hostname`
export DD_LEVEL='error'
export DD_MESSAGE_TEMPLATE='{{message}} from {{room}} by {{user}}'
export DD_SITE='datadoghq.com'

使用

hubot-datadog-plus 提供使用 Datadog API 创建事件并将事件发送到 Datadog 监控平台的功能。你可以在你的自定义脚本中使用下列方法：

`robot.emitDatadog(level, message, callback)`

发送事件。

level: 发送的事件级别。支持 "error"、"warning"、"info"、"success" 四种级别。
message: 事件标题。
callback: 回调函数，参数为 Datadog API 返回的响应。

下面是一个使用示例：

-- -------------------- ---- -------
-------------- - --------------- -
  ---------------------- ------------- -
    ------------------------- ----------------- ------------- -
      -- --------------- --- ---- -
        ------------- ------- -------------
      - ---- -
        ------------------
      -
    ---
  ---
--

结语

本文介绍了 hubot-datadog-plus 的安装、配置和使用，并为大家提供了一个使用示例，希望这篇文章对大家有所启发。

来源：JavaScript中文网，转载请注明来源 https://www.javascriptcn.com/post/600556bd81e8991b448d3872