Log History Service contains the properties that affect the overall operation of the service that collects log files from remote servers and creates a local searchable index.
This service collects specific log files from the local and remote servers into an archive directory on the local file system, then parses each record in the log files into a searchable index. Historical queries can then be satisfied by the index.
↓Relations To this Component
↓Properties
↓dsconfig Usage
The following components have a direct aggregation relation from Log History Services:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ enabled | None |
| ↓ log-history-index-dir | |
| ↓ log-history-archive-dir | |
| ↓ log-history-indexed-attribute | |
| ↓ log-history-attribute | |
| ↓ handler-class-name | |
| ↓ log-history-server | |
| ↓ poll-interval |
| Description | Indicates whether this Log History Service is enabled for use. If Log History Service is enabled for use it will poll itself for logs. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the path to the directory that will be used to store the index files. It may be either an absolute path or a path relative to the base of the Identity Broker instance. If this value is changed the current contents will need to be manually moved to the new location before the server is restarted. |
| Default Value | None |
| Allowed Values | Unknown |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The Identity Broker must be restarted for changes to this setting to take effect. Modification requires that the Identity Broker be stopped, the existing directory manually relocated, and then the Identity Broker restarted. While the Identity Broker is stopped, the old index directory and its contents must be manually moved or copied to the new location. |
| Description | Specifies the path to the directory that will be used to store the archived log files. It may be either an absolute path or a path relative to the base of the Identity Broker instance. If this value is changed the current contents will need to be manually moved to the new location before the server is restarted. |
| Default Value | None |
| Allowed Values | Unknown |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | The Identity Broker must be restarted for changes to this setting to take effect. Modification requires that the Identity Broker be stopped, the existing directory manually relocated, and then the Identity Broker restarted. While the Identity Broker is stopped, the old log archive directory and its contents must be manually moved or copied to the new location. |
| Description | Specifies the attributes that will be indexed. Each log record includes a number of attributes that may be included in the index and serve as part of the selection criteria for a historical search. Changing the indexed attributes does not cause existing indexes to be re-created. It does cause the new attributes to be in the indexes created from that point forward which means searches for newly added attributes will not match records in older indexes. Indexed attributes must be a subset of the history attributes. Attributes selected for indexing should be highly selective or queries using the attribute will have poor performance. A highly selective attribute is an attribute that has a relatively unique value across all records. A non-highly selective attribute would be an attribute whose value is an enumerated type. There must be at least one indexed attribute. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | The Identity Broker must be restarted for changes to this setting to take effect. This modification requires that you manually restart the server for the change to take effect |
| Description | Specifies the attributes that will be available from the index. Each log record includes a number of attributes that may be stored in the index and retrieved when reading records from the index. Attributes defined here are stored in the index and will be available in index query results, and may be used in the construction of the query. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | Yes |
| Required | Yes |
| Admin Action Required | The Identity Broker must be restarted for changes to this setting to take effect. This modification requires that you manually restart the server for the change to take effect |
| Description | Fully qualified name of Java class that should be used to handle indexing of log files. Each log file contains one or more different types of records, and a specific handler is needed for each record type. This property specifies the handler that will be used for the specific log. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Sources of logs to be archived and indexed. The Log History Service polls one or more External Servers to fetch logs for indexing. It is possible for more than one Identity Broker to index logs, although each Identity Broker must index all logs as there is no facility to partition the index. This attribute contains a list of sources for the Log History Service to poll for logs. Valid values are the ID of any External Server. If an External Server is specified, Log History Service will poll the External Server via HTTP for new decision log files. If Log History Service is enabled it will poll itself for log files. |
| Default Value | Only local server is polled. |
| Allowed Values | The DN of any Identity Broker External Server. |
| Multi-Valued | Yes |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies how frequently the Log History Service should check the external Identity Broker servers to determine whether a new log has been added. |
| Default Value | 5 minutes |
| Allowed Values | A duration. Lower limit is 1 seconds. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
To list the configured Log History Services:
dsconfig list-log-history-services
[--property {propertyName}] ...
To view the configuration for an existing Log History Service:
dsconfig get-log-history-service-prop
--service-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Log History Service:
dsconfig set-log-history-service-prop
--service-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Log History Service:
dsconfig create-log-history-service
--service-name {name}
--set log-history-index-dir:{propertyValue}
--set log-history-archive-dir:{propertyValue}
--set log-history-indexed-attribute:{propertyValue}
--set log-history-attribute:{propertyValue}
--set handler-class-name:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Log History Service:
dsconfig delete-log-history-service
--service-name {name}