Access Log Filtering Criteria
A set of rules which together determine whether a log record should be logged or not.
Access Log Filtering Criteria properties
You can use configuration expressions to set property values at startup time. For details, see Property value substitution.
connection-client-address-equal-to
Synopsis |
Filters log records associated with connections which match at least one of the specified client host names or address masks. |
Description |
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. |
Default value |
None |
Allowed values |
An IP address mask. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
connection-client-address-not-equal-to
Synopsis |
Filters log records associated with connections which do not match any of the specified client host names or address masks. |
Description |
Valid values include a host name, a fully qualified domain name, a domain name, an IP address, or a subnetwork with subnetwork mask. |
Default value |
None |
Allowed values |
An IP address mask. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
connection-port-equal-to
Synopsis |
Filters log records associated with connections to any of the specified listener port numbers. |
Default value |
None |
Allowed values |
An integer. Lower limit: 1. Upper limit: 65535. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
connection-protocol-equal-to
Synopsis |
Filters log records associated with connections which match any of the specified protocols. |
Description |
Typical values include "ldap", "ldaps", or "jmx". |
Default value |
None |
Allowed values |
The protocol name as reported in the access log. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
log-record-type
Synopsis |
Filters log records based on their type. |
Default value |
None |
Allowed values |
|
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
request-target-dn-equal-to
Synopsis |
Filters operation log records associated with operations which target entries matching at least one of the specified DN patterns. |
Description |
Valid DN filters are strings composed of zero or more wildcards. A double wildcard replaces one or more RDN components (as in uid=dmiller,,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com). |
Default value |
None |
Allowed values |
A string. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
request-target-dn-not-equal-to
Synopsis |
Filters operation log records associated with operations which target entries matching none of the specified DN patterns. |
Description |
Valid DN filters are strings composed of zero or more wildcards. A double wildcard replaces one or more RDN components (as in uid=dmiller,,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com). |
Default value |
None |
Allowed values |
A string. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
response-entry-size-greater-than
Synopsis |
Filters operation response log records associated with operations which target one or more entries whose encoded size is bigger than the specified size. |
Description |
Frequent operations on large entries may impact performance. It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages. |
Default value |
0 KB |
Allowed values |
Uses size syntax. |
Multi-valued |
No |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
response-etime-greater-than
Synopsis |
Filters operation response log records associated with operations which took longer than the specified number of milli-seconds to complete. |
Description |
It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages. |
Default value |
None |
Allowed values |
An integer. Lower limit: 0. |
Multi-valued |
No |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
response-etime-less-than
Synopsis |
Filters operation response log records associated with operations which took less than the specified number of milli-seconds to complete. |
Description |
It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages. |
Default value |
None |
Allowed values |
An integer. Lower limit: 0. |
Multi-valued |
No |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
response-result-code-equal-to
Synopsis |
Filters operation response log records associated with operations which include any of the specified result codes. |
Description |
It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages. |
Default value |
None |
Allowed values |
An integer. Lower limit: 0. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
response-result-code-not-equal-to
Synopsis |
Filters operation response log records associated with operations which do not include any of the specified result codes. |
Description |
It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages. |
Default value |
None |
Allowed values |
An integer. Lower limit: 0. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
search-response-is-indexed
Synopsis |
Filters search operation response log records associated with searches which were either indexed or unindexed. |
Description |
It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages. |
Default value |
None |
Allowed values |
true false |
Multi-valued |
No |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
search-response-nentries-greater-than
Synopsis |
Filters search operation response log records associated with searches which returned more than the specified number of entries. |
Description |
It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages. |
Default value |
None |
Allowed values |
An integer. Lower limit: 0. |
Multi-valued |
No |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
search-response-nentries-less-than
Synopsis |
Filters search operation response log records associated with searches which returned less than the specified number of entries. |
Description |
It is recommended to only use this criteria in conjunction with the "combined" output mode of the access logger, since this filter criteria is only applied to response log messages. |
Default value |
None |
Allowed values |
An integer. Lower limit: 0. |
Multi-valued |
No |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
user-dn-equal-to
Synopsis |
Filters log records associated with users matching at least one of the specified DN patterns. |
Description |
Valid DN filters are strings composed of zero or more wildcards. A double wildcard replaces one or more RDN components (as in uid=dmiller,,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com). |
Default value |
None |
Allowed values |
A string. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |
user-dn-not-equal-to
Synopsis |
Filters log records associated with users which do not match any of the specified DN patterns. |
Description |
Valid DN filters are strings composed of zero or more wildcards. A double wildcard replaces one or more RDN components (as in uid=dmiller,,dc=example,dc=com). A simple wildcard * replaces either a whole RDN, or a whole type, or a value substring (as in uid=bj*,ou=people,dc=example,dc=com). |
Default value |
None |
Allowed values |
A string. |
Multi-valued |
Yes |
Required |
No |
Admin action required |
None |
Advanced |
No |
Read-only |
No |