utexas / utexas_pantheon_logs_http
UTexas Pantheon Logs HTTP API 客户端。
Requires
- composer/installers: ^1 || ^2
- drupal/core: ^10
This package is auto-updated.
Last update: 2024-08-30 22:21:09 UTC
README
通过标签/http端点提供JSON事件推送到Splunk日志。
此模块基于 Logs HTTP 贡献模块,该模块被设计为一个通用的解决方案,用于将Watchdog日志推送到HTTP端点,例如 Logstash,或付费服务,如 Loggly。
此自定义分支添加了所需的功能,以便将托管在Pantheon上的站点上的Watchdog日志通过 UT Austin Splunk实例 通过 Splunk HTTP事件收集器(HEC) 推送。
已修改HTTP连接代码以满足Pantheon的 安全集成 平台功能要求,允许通过Pantheon和UT Austin网络之间现有的安全隧道发送消息。
此模块还允许使用Splunk HEC连接所需的加密令牌。有关HEC配置的更多信息,请参阅 (Splunk) HTTP事件收集器(HEC)。
提供的配置包括使Pantheon日志与Splunk之间建立连接的变量,这些变量是
- 端点:用于事件Post请求的“ping”Splunk URL
- 安全集成常量名称:一个特定于Pantheon的常量,其中包含构建连接Splunk的URL所需的端口(连同端点)
- Watchdog严重性:watchdog严重性级别值,设置为记录介于 Info 和 Error(除调试消息外)之间的任何内容
还需要一个最后的变量,但默认情况下没有提供,即 Splunk HTTP事件收集器令牌。
要求
- Drupal 9
- 现有的Pantheon安全集成配置,配置了UT Austin Splunk实例的IP地址和端口号
- 现有的Splunk HTTP事件收集器,配置了由安全集成配置提供的Pantheon IP地址列表。
如何使用
启用模块后,默认配置将在 admin/config/services/logs-http-client
设置。
Splunk HTTP事件收集器令牌
需要通过SFTP上传(如果未由Jenkins配置),可在 Stache 中找到,名称为 Splunk HEC Token PantheonAppLogs
。新文件必须命名为 splunk_settings.json
,必须上传到 /files/private/splunk
,并且必须具有以下格式
{
"splunk_settings":{
"splunk_hec_token":"[the-token-value]"
}
}
一旦设置完成后,任何随后的看门狗日志都将发送到Splunk。为了验证网站是否正确记录数据,您可以访问 admin/config/services/logs-http-client
并查找顶部是否有消息说明是否找到了 Splunk 认证令牌
。或者,访问这个 Splunk 链接,并将 request_uri
参数替换为 https://yourpantheonsite.pantheonsite.io/*
。如果在搜索结果中找到匹配项,则表示模块已正确配置。
调试
使用Logger类在您的看门狗日志上打印通知是调试此模块内容的最有效方法。