12. 日志记录和聚合¶

12.1.1. 日志消息 schema¶

所有日志记录器的通用 schema：

• cluster_host_id: 控制器集群中主机的唯一标识符

• level：标准的 python 日志级别，它大致反映了事件的重要性。作为该功能的一部分，所有的数据日志记录器都使用 INFO 级别，但其他控制器日志会根据情况使用不同的级别

• logger_name：在设置中使用的日志记录器的名称，例如：“activity_stream”

• @timestamp：日志时间

• path：日志生成的代码中的文件路径

12.1.2. 活动流 schema¶

• （通用）：这使用以上列出的所有日志记录器通用的所有字段

• actor：日志中记录的执行操作的用户的用户名

• changes：字段更改的 JSON 概述，及其旧/新值。

• operation：活动流中已更改的日志的基本类别，例如：“关联”。

• object1：有关操作的主要对象的信息，与活动流中显示的内容一致

• object2：如果适用，涉及该操作的第二个对象

12.1.3. 作业事件 schema¶

该日志记录器反映了保存到作业事件中的数据，除非它们可能与来自日志记录器的预期标准字段冲突，在这种情况下，字段被嵌套。特别是，job_event 模型上的字段主机给定为 event_host。在有效负载中还有一个子字典字段 event_data，它包含不同的字段，具体取决于 Ansible 事件的具体情况。

这个日志记录器还包括通用字段。

12.1.4. 扫描/事实 (fact) /系统跟踪数据 schema¶

这些字段包括了服务、软件包或文件的详细字典类型字段。

• （通用）：这使用以上列出的所有日志记录器通用的所有字段

• services：对于服务扫描，此字段会根据服务的名称包含并具有密钥。备注：周期通过弹性搜索名称来禁止，并通过我们的日志格式器替换为“_”

• package：对软件包扫描中的日志消息包含在内

• files：对文件扫描的日志消息包含在内

• host：主机扫描的名称适用于

• inventory_id：清单 id 主机位于其中

12.1.5. 作业状态更改¶

与作业事件相比，这具有较少的数据，用来提供有关作业状态变化的信息。它还旨在捕获对基于作业模板的作业以外的统一作业类型的更改。

除了常见字段外，这些日志还包含作业模型中存在的字段。

12.1.6. Controller 日志¶

除了通用字段外，这还包含带日志消息的 msg 字段。错误包含一个单独的字段 traceback。这些日志可使用 Logging 设置页面中的 ENABLE EXTERNAL LOGGING 选项启用或禁用。

12.1.7. 日志记录聚合器服务¶

日志记录聚合器服务用于以下监控和数据分析系统：

12.1.7.1. Splunk¶

Automation controller 的 Splunk 日志记录集成使用 Splunk HTTP 收集器。在配置 SPLUNK 日志记录聚合器时，将完整 URL 添加到 HTTP 事件收集器主机，如下例所示：

https://yourcontrollerfqdn.com/api/v2/settings/logging

{
    "LOG_AGGREGATOR_HOST": "https://yoursplunk:8088/services/collector/event",
    "LOG_AGGREGATOR_PORT": null,
    "LOG_AGGREGATOR_TYPE": "splunk",
    "LOG_AGGREGATOR_USERNAME": "",
    "LOG_AGGREGATOR_PASSWORD": "$encrypted$",
    "LOG_AGGREGATOR_LOGGERS": [
        "awx",
        "activity_stream",
        "job_events",
        "system_tracking"
    ],
    "LOG_AGGREGATOR_INDIVIDUAL_FACTS": false,
    "LOG_AGGREGATOR_ENABLED": true,
    "LOG_AGGREGATOR_CONTROLLER_UUID": ""
}

Splunk HTTP 事件收集器默认在 8088 上侦听，因此需要提供完整的 HEC 事件 URL（附带端口），以便成功处理传入请求。这些值在以下示例中输入：

有关配置 HTTP 事件收集器的进一步说明，请参阅 Splunk documentation。

12.1.7.2. Loggly¶

要通过 Loggly 的 HTTP 端点来设置日志的发送，请参阅 https://www.loggly.com/docs/http-endpoint/. Loggly 使用 http://logs-01.loggly.com/inputs/TOKEN/tag/http/ 描述的 URL 惯例。在下例中，它已被输入到 Logging Aggregator 字段中：

12.1.7.3. Sumologic¶

在 Sumologic 中，创建一个包含 json 文件的搜索条件，该文件提供用于收集所需数据的参。

filter {
  json {
    source => "message"
  }
}

12.2.1. 日志聚合¶

将日志记录设置为任何聚合器类型：

1. 点左侧导航栏中的 Settings。

2. 在系统选项列表中，点 Logging settings。

3. 在 Logging 设置屏幕底部点 Edit。

4. 从提供的字段中设置可配置选项：

• Enable External Logging：如果要将日志发送到外部日志聚合器，请点击切换按钮切换到 ON。

• Logging Aggregator：输入您要发送日志的主机名或 IP 地址。

• Logging Aggregator Port：如果聚合器需要端口，请为其指定端口。

• Logging Aggregator Type：点击可从下拉菜单中选择聚合器服务：

• Logging Aggregator Username：如果需要，请输入日志聚合器的用户名。

• Logging Aggregator Password/Token：如果需要，请输入日志聚合器的密码。

• Log System Tracking Facts Individually：点击工具提示 图标可查看是否要打开的附加信息，或者默认保持关闭。

• Logging Aggregator Protocol：点击选择一个连接类型（协议）与日志聚合器通信。后续选项根据所选协议的不同而有所变化。

• Logging Aggregator Level Threshold：选择希望日志处理器报告的严重性级别。

• TCP Connection Timeout：以秒为单位指定连接超时时间。此选项仅适用于 HTTPS 和 TCP 日志聚合协议。

• Enable/disable HTTPS certificate verification：HTTPS 日志协议默认启用证书验证。如果您不希望日志处理器在建立连接前验证由外部日志聚合器发送的 HTTPS 证书，请点击切换按钮切换到 OFF。

• Loggers to Send Data to the Log Aggregator Form：所有四类数据都是默认预先填充。点击字段旁的工具提示 图标可查看每种数据类型的附加信息。删除您不想要的数据类型。

• Log Format for API 4XX Errors：配置特定错误消息。如需更多详情，请参阅 API 4XX 错误配置。

5. 检查您选择的日志记录聚合的条目。以下是为 Splunk 设置的示例：

7. 完成后，点击 Save 应用设置，或者点 Cancel 取消更改。

8. 要验证您的配置是否正确设置，请首先点击 Save 再点 Test。这会使用 automation controller 中的当前日志配置向日志聚合器发送测试日志消息。您需要进行检查，以确保外部日志聚合器收到这个测试消息。

12.2.2. API 4XX 错误配置¶

当对 API 的请求存在问题时，API 在出错时通常返回一个在 400 范围内的 HTTP 错误代码。当发生这种情况时，将在日志中生成一个出错信息，其遵循以下模式：

` status {status_code} received by user {user_name} attempting to access {url_path} from {remote_addr} `

这些消息可根据需要进行配置。要修改默认的 API 4XX 错误消息格式，请执行以下操作：

1. 点左侧导航栏中的 Settings。

2. 在系统选项列表中，点 Logging settings。

3. 在 Logging 设置屏幕底部点 Edit。

4. 修改字段 Log Format For API 4XX Errors。

在生成日志错误时，由 {} 围绕的项将被替换。可以使用以下变量：

• status_code：API 返回的 HTTP 状态代码

• user_name：在发出 API 请求时要验证的用户名称

• url_path：被调用的 URL 的路径部分（也称为 API 端点）

• remote_addr: 控制器接收的远程地址

• error: API 返回的错误消息，如果没有指定错误，则为文本形式的 HTTP 状态

12.3.1. 日志记录聚合¶

如果您使用测试按钮通过 http/https 向配置的日志记录服务发送了一条消息，但却没有接收到这个消息，请检查 /var/log/tower/rsyslog.err 日志文件。当使用 http/https 外部日志记录服务验证 rsyslog 出错时，错误信息会被记录在这个文件中。请注意，如果没有错误，则该文件将不存在。

12.3.2. API 4XX 错误¶

您可以通过修改这些消息的日志格式来包括 4XX 错误的 API 错误消息。如需更多详情，请参阅 API 4XX 错误配置 部分。

12.3.3. LDAP¶

您可以为 LDAP 适配器启用日志记录信息。如需更多详情，请参阅 为 LDAP 启用日志记录 部分。

12.3.4. SAML¶

您可以象为 LDAP 启用日志记录一样，为 SAML 适配器启用日志信息。如需更多详情，请参阅 为 LDAP 启用日志记录 部分。