Json File Access Log Publishers Publish access messages to Json files.
The Json File Access Log Publisher component inherits from the Access Log Publisher
The following components have a direct AGGREGATION relation FROM Json File Access Log Publishers :
A description of each property follows.
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ enabled | ↓ java-class |
| ↓ filtering-policy | ↓ suppress-internal-operations |
| ↓ log-control-oids | ↓ suppress-synchronization-operations |
| ↓ log-directory | |
| ↓ retention-policy | |
| ↓ rotation-policy |
| 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 |
| Description | Specifies how filtering criteria should be applied to log records. |
| Default Value | no-filtering |
| Allowed Values | exclusive - Records must not match any of the filtering criteria in order to be logged. inclusive - Records must match at least one of the filtering criteria in order to be logged. no-filtering - No filtering will be performed, and all records will be logged. |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | Specifies whether control OIDs will be included in operation log records. |
| Default Value | false |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | No |
| Read-only | No |
| Description | The directory to use for the log files generated by the Json File Access Log Publisher. The path to the directory is relative to the server root. |
| Default Value | logs |
| Allowed Values | A path to an existing directory that is readable and writable by the server. |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | The Json File Access Log Publisher must be disabled and re-enabled for changes to this setting to take effect |
| Advanced Property | No |
| Read-only | No |
| Description | The retention policy to use for the Json File 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 |
| Description | The rotation policy to use for the Json File 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 |
| Description | The fully-qualified name of the Java class that provides the Json File Access Log Publisher implementation. |
| Default Value | org.opends.server.loggers.JsonFileAccessLogPublisher |
| Allowed Values | A java class that implements or extends the class(es) : org.opends.server.loggers.LogPublisher |
| Multi-valued | No |
| Required | Yes |
| Admin Action Required | None |
| Advanced Property | Yes |
| Read-only | No |
| Description | Indicates whether internal operations (for example, operations that are initiated by plugins) should be logged along with the operations that are requested by users. |
| Default Value | true |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | Yes |
| Read-only | No |
suppress-synchronization-operations
| Description | Indicates whether access messages that are generated by synchronization operations should be suppressed. |
| Default Value | false |
| Allowed Values | true false |
| Multi-valued | No |
| Required | No |
| Admin Action Required | None |
| Advanced Property | Yes |
| Read-only | No |