report

Suggest Edits

Version: `v2025-01-13`	Includes use: Yes

Behavior name: Log Request Details

Specify the HTTP request headers or cookie names to log in your Log Delivery Service reports.

Default behavior

These samples reflect the behavior's default settings. You can use these as is in your configurations or make adjustments based on the behavior's available options.

data "akamai_property_rules_builder" "report" {
  rules_v2025_02_18 {
    name     = "Log Request Details"
    comments = "Specifies the HTTP request headers or cookie names to log in your Log Delivery Service reports."
    behavior {
      report {
        log_host             = true
        log_referer          = false
        log_user_agent       = false
        log_accept_language  = false
        log_cookies          = "OFF"
        log_custom_log_field = false
        log_edge_ip          = false
        log_x_forwarded_for  = false
      }
    }
  }
}

"behaviors": [
  {
    "name": "report",
    "options": {
      "logHost": true,
      "logReferer": false,
      "logUserAgent": false,
      "logAcceptLanguage": false,
      "logCookies": "OFF",
      "logCustomLogField": false,
      "logEdgeIP": false,
      "logXForwardedFor": false
    }
  }
]

Options

Option	Description
`log_host`	Boolean Log the `Host` header.
`log_referer`	Boolean Log the `Referer` header.
`log_user_agent`	Boolean Log the `User-Agent` header.
`log_accept_language`	Boolean Log the `Accept-Language` header.
`log_cookies`	Enum Specifies the set of cookies to log. Value is one of: `OFF`. Do not log cookies. `ALL`. Log all cookies. `SOME`. A specific set of `cookies`.
`cookies`	String array \| Requires: `log_cookies` is `SOME` This specifies the set of cookies names whose values you want to log.
`log_custom_log_field`	Boolean Whether to append additional custom data to each log line.
`custom_log_field`	String \| Requires: `log_custom_log_field` is `true` Specifies an additional data field to append to each log line, maximum 1000 bytes, typically based on a dynamically generated built-in system variable. For example, `round-trip: {{builtin.AK_CLIENT_TURNAROUND_TIME}}ms` logs the total time to complete the response. See Support for variables for more information. If you enable the `log_custom` behavior, it overrides the `custom_log_field` option.
`log_edge_ip`	Boolean Whether to log the IP address of the Akamai edge server that served the response to the client.
`log_x_forwarded_for`	Boolean Log any `X-Forwarded-For` request header.

Updated about 1 hour ago