本文档介绍了 OpenZeppelin Defender 的日志功能,包括日志记录的各种事件(如用户操作、自动化活动),日志条目的结构(模块、时间、严重性等),以及如何将日志转发到 Datadog 和 Splunk 等外部服务进行聚合和分析。还提供了设置日志转发到 Splunk 和 Datadog 的具体步骤和示例。
Defender 会生成系统中每个可能相关的事件的日志轨迹。这包括手动操作,例如修改 Action 或 Monitor,以及自动活动,例如发送交易或触发通知。日志可以选择性地转发到 Datadog 和 Splunk 进行聚合或导出。
通过监控团队成员的登录和整个应用程序中的活动来跟踪用户操作
检测因登录尝试失败而可能对你的基础设施造成的攻击
跟踪中继器活动,以了解从你的帐户发送的交易
保留所有模块配置更改的审计跟踪
按严重程度、类型、用户、模块、时间等进行过滤
每个日志条目都采用以下格式构建:
Module
:日志条目的来源,例如 Monitor、Actions、Workflows、Deploy 等。
Date and Time
:生成日志条目的日期和时间,格式为 Day Month Year
,并使用浏览器本地时区的 12 小时制时钟格式
Severity
:日志条目的严重程度,范围从 trace
到 error
Subject
:生成日志的触发器/原因。如果与合约相关,则显示合约名称
Event
:记录的活动类型。例如,Created
、Added
、Deledated
、Updated
等。
Description
:有关事件的详细信息。例如,Contract was updated
、Address book entry was updated
等。
User
:直接或间接生成日志条目的团队用户
你可以单击每个日志条目以获取详细视图,其中包括 tenant id、user id、活动响应、请求、日志 id、timestamp 等。
生成的日志可以转发到 Datadog 和 Splunk,或任何其他支持 API Key 身份验证的服务。你可以使用它来将整个基础设施中的所有日志聚合到一个地方。
要设置日志转发目标,请打开 Logs 页面,然后单击“Send Logs to an External Service”按钮。
表单字段:
URL 字段是必填字段。所有日志都使用 HTTP POST 转发到此 URL 地址。
API Header Name 是可选的。这是包含 API Key 值的请求头的名称。大多数日志管理服务都需要它。请参考你的日志管理服务文档以确定是否需要它。
API Key 是一个可选字段。API Key 随每个请求一起发送,用于身份验证。大多数日志管理服务都需要它。请参考你的日志管理服务文档以确定是否需要它。
Log Types 允许你根据 Defender 组件指定要转发的 Defender 生成的日志的子集。
Log Levels 允许你根据日志级别指定要转发的 Defender 生成的日志的子集。例如,debug 日志可用于 Autotasks 调试目的,它们可能包含不应导出到外部系统的数据。
在下一节中,我们将介绍如何使用 Splunk 和 Datadog 设置日志转发,但值得注意的是,日志转发适用于任何其他支持 API Key 身份验证的服务。 |
通过使用 Splunk HEC(HTTP Event Collector)完成将日志转发到 Splunk。 有关使用 Splunk HEC 设置日志记录的文档,请参见此处。
由于 Splunk 内部原因,日志转发不适用于 Splunk 试用帐户。 |
示例:
URL: https://username.splunkcloud.com/services/collector/raw
API Header Name: Authorization
API Key: Splunk xxxxxxxxxxxxxxxxxxxxxxxxxxx
URL 值是动态的,因为 URL 包括帐户用户名。 |
API Key 应包含 Splunk 前缀。 |
有关在 Datadog 上设置日志记录的文档,请参见此处。
示例:
URL: https://http-intake.logs.datadoghq.com/api/v2/logs
API Header Name: DD-API-KEY
API Key: xxxxxxxxxxxxxxxxxxxxxxxxxxx
Datadog 在世界各地使用不同的站点。例如,如果你依赖欧盟服务器,则 URL 字段值应为 https://http-intake.logs.datadoghq.eu/api/v2/logs |
可以通过从左侧菜单打开 Logs 部分,从 Datadog 站点获取 API Key 值。<br>转到 Cloud 部分并选择 AWS 提供商。<br>完成这些步骤后,API Key 值将显示在页面底部。 |
- 原文链接: docs.openzeppelin.com/de...
- 登链社区 AI 助手,为大家转译优秀英文文章,如有翻译不通的地方,还请包涵~
如果觉得我的文章对您有用,请随意打赏。你的支持将鼓励我继续创作!