› ›

PagerDuty 输出插件

编辑

PagerDuty 输出插件

编辑

插件版本: v3.0.9
发布日期: 2020-01-27
变更日志

其他版本请参见版本化插件文档。

安装

编辑

对于非默认捆绑的插件，可以通过运行 bin/logstash-plugin install logstash-output-pagerduty 轻松安装。更多详情请参见使用插件。

获取帮助

编辑

如有任何关于插件的问题，请在 Discuss 论坛中发帖。如发现错误或有功能需求，请在 Github 中提交问题。Elastic 支持的插件列表，请参考 Elastic 支持矩阵。

描述

编辑

PagerDuty 输出插件将根据预先配置的服务和升级策略发送通知。Logstash 可以发送“触发”、“确认”和“解决”事件类型。此外，您可以配置自定义描述和事件详细信息。唯一必需的字段是 PagerDuty 的“服务 API 密钥”，您可以在 pagerduty.com 上的服务网页中找到它。在默认情况下，描述和事件详细信息将由 Logstash 使用 message、timestamp 和 host 数据填充。

PagerDuty 输出配置选项

编辑

此插件支持以下配置选项以及稍后描述的通用选项。

设置	输入类型	必填
`描述`	字符串	否
`详情`	哈希表	否
`事件类型`	字符串，其中之一为 `["trigger", "acknowledge", "resolve"]`	否
`事件密钥`	字符串	否
`pdurl`	字符串	否
`服务密钥`	字符串	是

另请参见通用选项，了解所有输出插件支持的选项列表。

`description`

编辑

值类型为字符串
默认值为 "Logstash event for %{host}"

自定义描述

`details`

编辑

值类型为哈希表
默认值为 {"timestamp"=>"%{@timestamp}", "message"=>"%{message}"}

事件详细信息。这可能是您希望包含的 Logstash 事件字段中的数据。如果检测到标签，则会自动包含它们，因此无需在此处显式添加它们。

`event_type`

编辑

值可以是：trigger、acknowledge、resolve
默认值为 "trigger"

事件类型

`incident_key`

编辑

值类型为字符串
默认值为 "logstash/%{host}/%{type}"

要使用的服务密钥。您需要提前在 PagerDuty 中设置它。

`pdurl`

编辑

值类型为字符串
默认值为 "https://events.pagerduty.com/generic/2010-04-15/create_event.json"

PagerDuty API URL。您不需要更改此设置，但包含它是为了允许灵活性，万一 PagerDuty 更新了 API 而 Logstash 尚未更新。

`service_key`

编辑

这是一个必填设置。
值类型为字符串
此设置没有默认值。

PagerDuty 服务 API 密钥

通用选项

编辑

所有输出插件都支持这些配置选项

设置	输入类型	必填
`编解码器`	编解码器	否
`启用指标`	布尔值	否
`ID`	字符串	否

`codec`

编辑

值类型为编解码器
默认值为 "plain"

用于输出数据的编解码器。输出编解码器是在数据离开输出之前对其进行编码的一种便捷方法，无需在 Logstash 管道中使用单独的过滤器。

`enable_metric`

编辑

值类型为布尔值
默认值为 true

禁用或启用此特定插件实例的指标日志记录。默认情况下，我们会记录所有可以记录的指标，但是您可以为特定插件禁用指标收集。

`id`

编辑

值类型为字符串
此设置没有默认值。

向插件配置添加唯一的 ID。如果没有指定 ID，Logstash 将生成一个。强烈建议您在配置中设置此 ID。当您拥有两种或更多相同类型的插件时，这尤其有用。例如，如果您有两个 pagerduty 输出。在这种情况下，添加命名的 ID 将有助于在使用监控 API 时监控 Logstash。

output {
  pagerduty {
    id => "my_plugin_id"
  }
}

id 字段中的变量替换仅支持环境变量，不支持使用密钥存储中的值。

« Opentsdb 输出插件 Pipe 输出插件 »