› ›

Pagerduty 输出插件

编辑

Pagerduty 输出插件

编辑

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

有关其他版本，请参阅版本化插件文档。

安装

编辑

对于默认未捆绑的插件，可以通过运行 bin/logstash-plugin install logstash-output-pagerduty 轻松安装。有关更多详细信息，请参阅使用插件。

获取帮助

编辑

有关插件的问题，请在Discuss论坛中打开一个主题。对于错误或功能请求，请在Github中打开一个问题。有关 Elastic 支持的插件列表，请查阅Elastic 支持矩阵。

描述

编辑

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

Pagerduty 输出配置选项

编辑

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

设置	输入类型	必需
`description`	字符串	否
`details`	哈希	否
`event_type`	字符串，以下值之一 `["trigger", "acknowledge", "resolve"]`	否
`incident_key`	字符串	否
`pdurl`	字符串	否
`service_key`	字符串	是

另请参阅通用选项，其中列出了所有输出插件支持的选项。

`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 密钥

通用选项

编辑

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

设置	输入类型	必需
`codec`	codec	否
`enable_metric`	布尔值	否
`id`	字符串	否

`codec`

编辑

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

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

`enable_metric`

编辑

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

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

`id`

编辑

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

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

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

id 字段中的变量替换仅支持环境变量，不支持使用 secret store 中的值。

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