Documentation

MessageFormatter
in package

Formats log messages using variable substitutions for requests, responses, and other transactional data.

The following variable substitutions are supported:

  • {request}: Full HTTP request message
  • {response}: Full HTTP response message
  • {ts}: ISO 8601 date in GMT
  • {date_iso_8601} ISO 8601 date in GMT
  • {date_common_log} Apache common log date using the configured timezone.
  • {host}: Host of the request
  • {method}: Method of the request
  • {uri}: URI of the request
  • {version}: Protocol version
  • {target}: Request target of the request (path + query + fragment)
  • {hostname}: Hostname of the machine that sent the request
  • {code}: Status code of the response (if available)
  • {phrase}: Reason phrase of the response (if available)
  • {error}: Any error messages (if available)
  • {req_header_*}: Replace * with the lowercased name of a request header to add to the message
  • {res_header_*}: Replace * with the lowercased name of a response header to add to the message
  • {req_headers}: Request headers
  • {res_headers}: Response headers
  • {req_body}: Request body
  • {res_body}: Response body

Table of Contents

CLF  = "{hostname} {req_header_User-Agent} - [{date_common_log}] "{method} {target} HTTP/{version}" {code} {res_header_Content-Length}"
Apache Common Log Format.
DEBUG  = ">>>>>>>> {request} <<<<<<<< {response} -------- {error}"
SHORT  = '[{ts}] "{method} {target} HTTP/{version}" {code}'
$template  : string
__construct()  : mixed
format()  : string
Returns a formatted message string.
headers()  : string
Get headers from message as string

Constants

DEBUG

public mixed DEBUG = ">>>>>>>> {request} <<<<<<<< {response} -------- {error}"

SHORT

public mixed SHORT = '[{ts}] "{method} {target} HTTP/{version}" {code}'

Properties

Methods

__construct()

public __construct([string $template = self::CLF ]) : mixed
Parameters
$template : string = self::CLF

Log message template

Return values
mixed —

Search results