Configuration Reference Home
Oracle Unified Directory - File Based HTTP Access Log Publisher

File Based HTTP Access Log Publisher

File Based HTTP Access Log Publishers publish access messages to the file system.

Parent Component

The File Based HTTP Access Log Publisher component inherits from the HTTP Access Log Publisher

Relations From this Component

The following components have a direct AGGREGATION relation FROM File Based HTTP Access Log Publishers :

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ access-log-format-mode ↓ asynchronous
↓ append ↓ auto-flush
↓ enabled ↓ buffer-size
↓ log-connection-details ↓ http-access-log-formatting-text
↓ log-file ↓ java-class
↓ log-file-permissions ↓ log-controls
↓ log-file-use-local-time ↓ log-date-time-format
↓ operations-to-log ↓ queue-size
↓ retention-policy ↓ time-interval
↓ rotation-policy

Basic Properties

access-log-format-mode

Description
The File Based HTTP Access Log Publisher supports standard access log formats. It can be one of the following: 1) nsca 2) extended
Default Value
nsca
Allowed Values
nsca - The NSCA common log format is a standarized text file format used by web servers when generating server log files. Each line in a file stored in the Common Log format has the following syntax: host ident authuser date request status bytes Example: 127.0.0.1 - foo [07/04/2000:13:55:36 -0700] "GET /users HTTP/1.0" 200 1111

w3c - W3C extended log file contains a sequence of lines containing ASCII characters terminated by either the sequence LF or CRLF.Entries consist of a sequence of fields relating to a single HTTP transaction. Fields are separated by whitespace, the use of tab characters for this purpose is encouraged. If a field is unused in a particular entry dash "-" marks the omitted field. Directives record information about the logging process itself. The definition of the format is available at http://www.w3.org/TR/WD-logfile.html. Example: 00:34:23 GET /foo/bar.html


Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

append

Description
Specifies whether to append to existing log files.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

enabled

Description
Indicates whether the Log Publisher is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

log-connection-details

Description
Indicates whether the connection details should be logged for the operation.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

log-file

Description
The file name to use for the log files generated by the File Based HTTP Access Log Publisher. The path to the file is relative to the server root.
Default Value
None
Allowed Values
A path to an existing file that is readable by the server.
Multi-valued
No
Required
Yes
Admin Action Required
The File Based HTTP Access Log Publisher must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
No
Read-only
No

log-file-permissions

Description
The UNIX permissions of the log files created by this File Based HTTP Access Log Publisher.
Default Value
640
Allowed Values
A valid UNIX mode string. The mode string must contain three digits between zero and seven.
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

log-file-use-local-time

Description
Specifies whether to use local time or GMT for the name of the rotated files.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

operations-to-log

Description
Indicates which operations has to be logged.
Default Value
administration user adminbrowsing
Allowed Values
adminbrowsing - operations which are performed with the "Network group selection" control (no Network group dependency).

administration - operations performed on the admin network group, excluding operation with "Network group selection" control.

all - All of the above (if specified, any other value specified for the attribute is ignored).

user - operations performed on any user network group should be logged, excluding operation with "Network group selection" control.


Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

retention-policy

Description
The retention policy to use for the File Based HTTP Access Log Publisher . When multiple policies are used, log files are cleaned when any of the policy's conditions are met.
Default Value
No retention policy is used and log files are never cleaned.
Allowed Values
The DN of any Log Retention Policy.
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No

rotation-policy

Description
The rotation policy to use for the File Based HTTP Access Log Publisher . When multiple policies are used, rotation will occur if any policy's conditions are met.
Default Value
No rotation policy is used and log rotation will not occur.
Allowed Values
The DN of any Log Rotation Policy.
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No


Advanced Properties

asynchronous

Description
Indicates whether the File Based HTTP Access Log Publisher will publish records asynchronously.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No

auto-flush

Description
Specifies whether to flush the writer after every log record. If the asynchronous writes option is used, the writer is flushed after all the log records in the queue are written.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

buffer-size

Description
Specifies the log file buffer size.
Default Value
64kb
Allowed Values
A positive integer representing a size. Lower value is 1.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

http-access-log-formatting-text

Description
Specifies how log records should be formatted and written to the HTTP access log. The access log format depends on the selection of the access log format mode. In case of an NSCA log format mode, only nsca keywords are allowed. Likewise, the extended log format requires only select keywords to be used in the format string.
Default Value
common
Allowed Values
Oracle Unified Directory supports all popular logging formats that are supported by the leading log parsing tools. The supported formats are NCSA Common,NSCA combined and W3C extended formats. In NSCA format mode, following keywords are supported: remotehost, user-identifier, authuser,date,request,status,bytes,referer, user_agent,cookie For descrition of each field, please refer http://www.w3.org/Daemon/User/Config/Logging.html. Oracle Unified Directory also supports the extended format that is described at http://www.w3.org/TR/WD-logfile.html. In extended format mode, following keywords are supported: c-ip, s-ip, c-port, date, s-port,cs-username,cs-method,cs-uri-query,sc-status,sc-bytes,cs-version,cs(User-Agent),cs(Cookie), cs(Referer). To offer extensibility to the user, Oracle Unified Directory provides an option to define the log format using aliases such as common, combined or extended. Which are defined as following: common="remotehost, user-identifier authuser date request status bytes" combined="remotehost user-identifier authuser date request status bytes referer user_agent cookie " extended=""However,it is also possible to define a space-separated list of fields describing the format of a user's choice as allowed by a particular log format mode. Oracle Unified Directory supports the following application specific field extensions: "x-internal-connection-id" displays the internal connection ID assigned to the HTTP client connection, "x-etime" displays the total execution time.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

java-class

Description
The fully-qualified name of the Java class that provides the File Based HTTP Access Log Publisher implementation.
Default Value
org.opends.server.loggers.http.TextHTTPAccessLogPublisher
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.api.HTTPAccessLogPublisher
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No

log-controls

Description
Indicates whether the request controls and response controls should be logged along with the operations that are requested by the client applications.
Default Value
false
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

log-date-time-format

Description
Specifies the date time format for logging. This value should be allowed by the Java simple date format class. For example, use [dd/MMM/yyyy:HH:mm:ss Z] for NSCA logging and yyyy-M-dd HH:mm:ss for W3C extended logging format.
Default Value
[dd/MMM/yyyy:HH:mm:ss Z]
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

queue-size

Description
The maximum number of log records that can be stored in the asynchronous queue. Setting the queue size to zero activates parallel log writer implementation which has no queue size limit and as such the parallel log writer should only be used on a very well tuned server configuration to avoid potential out of memory errors.
Default Value
5000
Allowed Values
An integer value. Lower value is 0.
Multi-valued
No
Required
No
Admin Action Required
The File Based HTTP Access Log Publisher must be restarted if this property is changed and the asynchronous property is set to true.
Advanced Property
Yes
Read-only
No

time-interval

Description
Specifies the interval at which to check whether the log files need to be rotated.
Default Value
5s
Allowed Values
A duration Syntax. Lower limit is 1 milliseconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No


Copyright © 2019, 2024, Oracle and/or its affiliates. All Rights Reserved.