Pagerduty 输出插件编辑

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

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

安装编辑

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

获取帮助编辑

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

描述编辑

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

Pagerduty 输出配置选项编辑

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

设置 输入类型 必需

描述

字符串

详细信息

哈希

事件类型

字符串["trigger", "acknowledge", "resolve"] 之一

事件密钥

字符串

pdurl

字符串

服务密钥

字符串

另请参阅通用选项,以获取所有输出插件支持的选项列表。

 

description编辑

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

自定义描述

details编辑

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

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

event_type编辑

  • 值可以是以下任意一项:triggeracknowledgeresolve
  • 默认值为 "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

字符串

enable_metric编辑

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

id编辑

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

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

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

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