概述
Graylog Provider 便于通过设置 Webhook 连接从 Graylog 接收告警。它允许与 Graylog 无缝集成,通过 Keep 接收有关事件和告警的通知。
认证
此提供商需要身份验证。
- graylog_user_name: 用户名(必需:True,敏感:False)
- graylog_access_token: Graylog 访问令牌(必需:True,敏感:True)
- deployment_url: 部署 URL(必需:True,敏感:False)
- verify: 验证 SSL 证书(必需:False,敏感:False)
某些范围可能需要才能通过提供商执行特定操作或查询。以下是相关范围及其用例的摘要:
- authenticated: 所有操作的必需项,确保用户已身份验证。(强制)
- authorized: 查询事件和管理资源的必需项,确保用户具有
Admin权限。(强制)
在工作流中
此提供商可用于工作流。
作为"步骤"来查询数据,示例:
yaml
steps:
- name: Query graylog
provider: graylog
config: "{{ provider.my_provider_name }}"
with:
events_search_parameters: {value}如果您需要此提供商的工作流示例,请提交 GitHub 问题。
提供商方法
search 使用 Graylog 中的弹性查询语言搜索(操作,范围:authorized)
query: 要搜索的查询字符串。query_type: 要使用的查询类型。默认为"elastic"。timerange_seconds: 时间范围(秒)。默认为 300 秒。timerange_type: 时间范围类型。默认为"relative"。page: 页码,从 0 开始。per_page: 每页结果数。
通过 Webhook 连接(双向)
此提供商支持 webhook。
要将警报从 Graylog 发送到 Keep,请使用以下 webhook URL 配置 Graylog 将警报发送到 Keep:
- 在 Graylog 中,从顶部栏转到
警报>通知。 - 点击"创建通知"。
- 在新通知表单中,配置:
注意:对于 Graylog v4.x,请将 URL 设置为 KEEP_BACKEND_URL/alerts/event/graylog?api_key={api_key}。
- 显示名称: keep-graylog-webhook-integration
- 标题: keep-graylog-webhook-integration
- 通知类型: 自定义 HTTP 通知
- URL: KEEP_BACKEND_URL/alerts/event/graylog # 将此 URL 加入白名单
- 头: X-API-KEY:
- 擦除正文模板。
- 点击"创建通知"。
- 转到
事件定义选项卡,选择将触发您要发送到 Keep 的警报的事件定义,然后点击更多 > 编辑。 - 转到"通知"选项卡。
- 点击"添加通知"并选择您在步骤 3 中创建的"keep-graylog-webhook-integration"。
- 点击"添加通知"。
- 点击
下一步>更新事件定义
连接 Provider
- 通过遵循 Graylog 的 API 访问文档 从您的 Graylog 实例获取用户名和访问令牌。
- 将部署 URL 设置为您的 Graylog 实例的基础 URL(例如
http://127.0.0.1:9000)。 - 确保用户在 Graylog 中具有Admin 角色。
功能
Graylog Provider 支持以下主要功能:
- Webhook 设置:配置 webhooks 以将告警发送到 Keep。
- 告警获取:根据指定的搜索参数从 Graylog 获取和格式化告警(仅最多 10000 条最近的告警)。
::: note 确保 page 和 per_page 的乘积不超过 10,000。 :::
::: note Graylog v4.x 的通知 URL 将 api_key 作为查询参数,这是默认行为。 :::