DocumentationDynamic Media Image Serving and Rendering API

Access logging access-logging

Last update: Fri Nov 03 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • Developer
  • Admin
  • User

Use these server settings for logging access.

Syntax

TC::directory - Log File Folder section-5d9e2168d4504bbe9868b7d6051c9d67

The folder to which the Platform Server writes log files. This can be an absolute path or a path relative to install_folder. Default is install_folder/logs.

NOTE
The new folder must be created before changing this setting. Make sure the folder has the correct read/write access privileges if Image Serving is installed to run under a user account other than root.

TC::maxDays - Number of Days to Keep Log Files section-45cbecffc5694c87b7d5c176a44a4885

The number of days log files should be preserved. New log files are created every day at midnight. At this time, the server deletes all files in the log file folder that are older than the specified number of days, including those written by the Image Server or Render Server. Default is 10.

TC::prefix - Access Log File Name section-1003856323b844049632710a5a056aa7

Name prefix for the file to which access log data is written. The date and the file suffix ( yyyy- mm- dd.log) are appended to the specified string. The name of the access log file must be different from that of the trace log file. Default is " access-".

TC::pattern - Access Log Pattern section-22775ea85cee444d8a7d7336a3b1feef

Specifies the data pattern for Platform Server access log records. The pattern string specifies variables which are substituted with their corresponding values. All other characters in the pattern string are transferred literally to the log record.

To use the cache warm-up utility, spaces must be used as field separators. The Platform Server replaces all spaces and ‘%’ characters in field values with %20 and %25, respectively.

The following pattern variables are supported:

Pattern
Description
%a
Remote IP address.
%A
Local IP address.
%b
Response byte count excluding HTTP headers, or ' ' if zero.
%B
Response byte count excluding HTTP headers.
%D
Request processing time in milliseconds.
%I
thread id (for cross-referencing debug/error log entries).
%G

date and time, formatted as yyyy - MM - dd HH : mm : ss . SSS offset

( SSS are msec, offset is the GMT time offset); the time value is captured when the response is sent to the client.

%m
Request method ( GET , POST , and so forth).
%O
Request overlap (number of requests processed concurrently).
%p
Local port on which this request was received.
%q
Query string (prepended with a '?' if it exists).
%r
First line of request (request method, URI, HTTP version).
%R
Same as %r , but applies limited HTTP-encoding to the URI to avoid log parsing problems.
%s
HTTP response status code.
%S
User session ID.
%t
Date and time, in Common Log Format.
%u
Remote user that was authenticated (if any), else ''.
%U
URI path.
%v
Local server name.
%T
Request processing time in seconds.
%{CacheKey}r
Platform Server cache key (cache file folder/name).
%{CacheUse}r
Platform Server cache management keyword: { REUSED | CREATED | UPDATED | REMOTE | REMOTE_CREATED | REMOTE_UPDATED | REMOTE_CACHE | VALIDATED | IGNORED | UNDEFINED } .
%{ContentType}r
The response MIME type.
%{Context}r
The destination context if a context forward occurs.
%{Digest}r
The etag response header value (MD5 signature of the response data).
%{Exception}r
Error message.
%{FetchTime}r
Time taken to retrieve cache entry or data from Image Server.
%{ParseTime}r
Time taken for request parsing and image catalog lookup.
%{PathBasedAccess}r
Indicates whether or not this request attempted any path-based access outside of the catalog system.
%{PeerServer}r
IP address of the peer server in the cache cluster which delivered the cache entry or '-' if CacheUse is neither REMOTE_CREATED nor REMOTE_UPDATED .
%{ProcessingStatus}r

Error category:

  • 0=no error.

  • 1=image(s) not found on the server.

  • 2=IS protocol usage error or a content error other than 1.

  • 3=other server error.

  • 4=request refused due to temporary server overload.

%{ReqType}r
The upper-cased value of req= .
%{RootId}r
The root id of the request's main catalog.
%{SendTime}r
The time it takes Platform Server to send response after writing data to the output stream.
%{Size}r
Like %B , but includes values for 304 (not modified) responses.
%{TransformedUrl}r
The final URL after all ruleset transformations.
%{ httpRequestHeader }i
The value of the specified HTTP request header.
%{ httpResponseHeader }
The value of the specified HTTP response header.

Default is "%G %a %s %{ProcessingStatus}r %{Size}r %D %{ParseTime}r %{FetchTime}r %O %{ReqType}r '%{RootId}r' %{CacheUse}r %R [%I] '%{Referer}i' %{Host}i %{X-Forwarded-For}i %{If-None-Match}i %{If-Match}i %{If-Modified-Since}i %{Digest}r %{ContentType}r %p %{Exception}r %{CacheKey}r %{PeerServer}" %{SendTime}r %{Context}r %{TransformedUrl}r %{PathBasedAccess}r.

recommendation-more-help
a26166cd-f2f4-45ce-996d-96a0f0d6cf49