11. Logging and Aggregation¶

11.1.1. Log message schema¶

Common schema for all loggers:

• cluster_host_id: Unique identifier of the host within the controller cluster

• level: Standard python log level, roughly reflecting the significance of the event All of the data loggers as a part of this feature use INFO level, but the other controller logs will use different levels as appropriate

• logger_name: Name of the logger we use in the settings, for example, “activity_stream”

• @timestamp: Time of log

• path: File path in code where the log was generated

11.1.2. Activity stream schema¶

• (common): This uses all the fields common to all loggers listed above

• actor: Username of the user who took the action documented in the log

• changes: JSON summary of what fields changed, and their old/new values.

• operation: The basic category of the changed logged in the activity stream, for instance, “associate”.

• object1: Information about the primary object being operated on, consistent with what we show in the activity stream

• object2: If applicable, the second object involved in the action

11.1.3. Job event schema¶

This logger reflects the data being saved into job events, except when they would otherwise conflict with expected standard fields from the logger, in which case the fields are nested. Notably, the field host on the job_event model is given as event_host. There is also a sub-dictionary field, event_data within the payload, which contains different fields depending on the specifics of the Ansible event.

This logger also includes the common fields.

11.1.4. Scan / fact / system tracking data schema¶

These contain a detailed dictionary-type fields that are either services, packages, or files.

• (common): This uses all the fields common to all loggers listed above

• services: For services scans, this field is included and has keys based on the name of the service. NOTE: Periods are disallowed by elastic search in names, and are replaced with “_” by our log formatter

• package: Included for log messages from package scans

• files: Included for log messages from file scans

• host: Name of host scan applies to

• inventory_id: Inventory id host is inside of

11.1.5. Job status changes¶

This is a intended to be a lower-volume source of information about changes in job states compared to job events, and also intended to capture changes to types of unified jobs other than job template based jobs.

In addition to common fields, these logs include fields present on the job model.

11.1.6. Controller logs¶

In addition to the common fields, this contains a msg field with the log message. Errors contain a separate traceback field. These logs can be enabled or disabled with the ENABLE EXTERNAL LOGGING option from the Logging settings page.

11.1.7. Logging Aggregator Services¶

The logging aggregator service works with the following monitoring and data analysis systems:

11.1.7.1. Splunk¶

Automation controller’s Splunk logging integration uses the Splunk HTTP Collector. When configuring a SPLUNK logging aggregator, add the full URL to the HTTP Event Collector host, like in the following example:

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 Event Collector listens on 8088 by default so it is necessary to provide the full HEC event URL (with port) in order for incoming requests to be processed successfully. These values are entered in the example below:

For further instructions on configuring the HTTP Event Collector, refer to the Splunk documentation.

11.1.7.2. Loggly¶

To set up the sending of logs through Loggly’s HTTP endpoint, refer to https://www.loggly.com/docs/http-endpoint/. Loggly uses the URL convention described at http://logs-01.loggly.com/inputs/TOKEN/tag/http/, which is shown inputted in the Logging Aggregator field in the example below:

11.1.7.3. Sumologic¶

In Sumologic, create a search criteria containing the json files that provide the parameters used to collect the data you need.

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

11.2.1. Log Aggregation¶

To set up logging to any of the aggregator types:

1. Click Settings from the left navigation bar.

2. Under the list of System options, click to select Logging settings.

3. At the bottom of the Logging settings screen, click Edit.

4. Set the configurable options from the fields provided:

• Enable External Logging: Click the toggle button to ON if you want to send logs to an external log aggregator.

• Logging Aggregator: Enter the hostname or IP address you want to send logs.

• Logging Aggregator Port: Specify the port for the aggregator if it requires one.

• Logging Aggregator Type: Click to select the aggregator service from the drop-down menu:

• Logging Aggregator Username: Enter the username of the logging aggregator if it requires it.

• Logging Aggregator Password/Token: Enter the password of the logging aggregator if it requires it.

• Log System Tracking Facts Individually: Click the tooltip icon for additional information whether or not you want to turn it on, or leave it off by default.

• Logging Aggregator Protocol: Click to select a connection type (protocol) to communicate with the log aggregator. Subsequent options vary depending on the selected protocol.

• Logging Aggregator Level Threshold: Select the level of severity you want the log handler to report.

• TCP Connection Timeout: Specify the connection timeout in seconds. This option is only applicable to HTTPS and TCP log aggregator protocols.

• Enable/disable HTTPS certificate verification: Certificate verification is enabled by default for HTTPS log protocol. Click the toggle button to OFF if you do not want the log handler to verify the HTTPS certificate sent by the external log aggregator before establishing a connection.

• Loggers to Send Data to the Log Aggregator Form: All four types of data are pre-populated by default. Click the tooltip icon next to the field for additional information on each data type. Delete the data types you do not want.

• Log Format For API 4XX Errors: Configure a specific error message. See API 4XX Error Configuration for further detail.

5. Review your entries for your chosen logging aggregation. Below is an example of one set up for Splunk:

7. When done, click Save to apply the settings or Cancel to abandon the changes.

11.2.2. API 4XX Error Configuration¶

When the API encounters an issue with a request, it will typically return an HTTP error code in the 400 range along with an error. When this happens, an error message will be generated in the log which follows the pattern:

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

These messages can be configured as required. To modify the default API 4XX errors log message format, do the following:

1. Click Settings from the left navigation bar.

2. Under the list of System options, click to select Logging settings.

3. At the bottom of the Logging settings screen, click Edit.

4. Modify the field Log Format For API 4XX Errors.

Items surrounded by {} will be substituted when the log error is generated. The following variables can be used:

• status_code: The HTTP status code the API is returning

• user_name: The name of the user that was authenticated when making the API request

• url_path: The path portion of the URL being called (aka the API endpoint)

• remote_addr: The remote address received by Controller

• error: The error message returned by the API or, if no error is specified, the HTTP status as text

11.3.1. API 4XX Errors¶

You can include the API error message for 4XX errors by modifying the log format for those messages. Refer to the API 4XX Error Configuration section for more detail.

11.3.2. LDAP¶

You can enable logging messages for the LDAP adapter. Refer to the Enabling Logging for LDAP section for more detail.

11.3.3. SAML¶

You can enable logging messages for the SAML adapter the same way you can enable logging for LDAP. Refer to the Enabling Logging for LDAP section for more detail.