Jump to: navigation, search

audit-expiration

Section: history-log
Default Value: 300
Valid Values: Any positive integer
Changes Take Effect: Immediately


Specifies the number of days of records to retain in the database. For example, if the value is set to 30, the records of the last 30 days will be kept in the database and older records will be deleted. The maximum value for this option is 365. Configuration Server cleans up the history records based on this option every 30 minutes.

Important
The value of this option must always be greater than expiration.

audit-expiration

Section: history-log
Default Value: 300
Valid Values: Any positive integer
Changes Take Effect: Immediately


Specifies the number of days of records to retain in the database. For example, if the value is set to 30, the records of the last 30 days will be kept in the database and older records will be deleted. The maximum value for this option is 365. Configuration Server cleans up the history records based on this option every 30 minutes.

Important
The value of this option must always be greater than expiration.

audit-max-records

Section: history-log
Default Value: 50000
Valid Values: Any positive integer
Changes Take Effect: Immediately


Specifies the maximum number of records that can be stored in the database. When the maximum number of records is reached, Master Configuration Server will delete the older records while adding new records. Genesys recommends not to set the value above 100000 for performance reasons. Configuration Server cleans up the history records based on this option every 30 minutes.

Important
The value of this option must always be greater than max-records.

expiration

Section: history-log
Default Value: 30
Valid Values: 1-30
Changes Take Effect: Immediately


Specifies the maximum number of days the records of configuration updates will be kept in the history log database before they are deleted.

max-records

Section: history-log
Default Value: 1000
Valid Values: 1-1000
Changes Take Effect: Immediately


Specifies the maximum number of records Configuration Server will send to a client in response to a history log data request.

Configuration History Log

The Configuration History Log consists of a set of a records that contains historical information about client sessions and changes to configuration objects. It enables a client to restore a session that was terminated by a service interruption, and request any changes to configuration objects that occurred during that service interruption.

For all Configuration Servers, the records are stored in the Configuration Database. Configuration Server Proxy reads the information from its primary Configuration Server. A limited number of latest records about object changes and client connections are synchronized with all Configuration Server Proxies to facilitate session restoration. Records about configuration object changes older than the value defined by the max-records and expiration options are not used for session restoration and can only be accessed from the master Configuration Server database, as explained in Accessing History Of Configuration Changes. These records provide extended audit information within the Configuration Server database.

The audit-max-records and audit-expirationaudit-expiration options enable you to manage an extended number of audit log records in the configuration database. Configuration Server cleans up the history records based on these options every 30 minutes.

The History Log comes with default parameters when you install Configuration Server. You configure the History Log parameters in the options of the Configuration Server Application object in Genesys Administrator. Refer to the Framework Configuration Options Reference for detailed descriptions of the configuration options that relate to the History Log.

When requested by a client that is recovering from a service interruption, Configuration Server or Configuration Server Proxy does the following:

  • Restores the client's session according to a client session record.
  • Returns all data that has been changed since that client disconnected.

History Log functionality is mandatory, and cannot be turned off permanently.

History Log Maintenance

No maintenance is required for the History Log, because it is maintained automatically by Configuration Server. The history log records are stored in the Configuration Database and are maintained using configuration records. Based on the expiration parameters, Configuration Server purges information from the database, both at startup and during normal operations.

History Log Errors

Any errors that occur when writing to the History Log generate Log Event 21-22138.

Important
Genesys strongly recommends that you associate an alarm with this Log Event, and that you inform Genesys Customer Care if you encounter any errors or corruption.

Minimizing Performance Impacts

Depending partially on the size of the updates, the History Log can affect the performance of Configuration Server. To minimize these performance impacts, you can turn off the History Log functionality temporarily by setting the active option to false for the Configuration Server Application object. The functionality will be turned back on either when you manually reset the option (to true), or when you restart Configuration Server.

Warning
When History Log functionality is turned off, current activities are not recorded. Therefore, clients that are disconnected during this time cannot retrieve the updates necessary to restore their sessions.

If you want to keep the History Log active (that is, active=true, consider setting write-former-value=false when performing large or significant updates. This will prevent previous values from being written to the history database, but will greatly improve performance.

Refer to the Framework Configuration Options Reference for more information about the options used to configure the Configuration Server History Log.

This page was last modified on August 12, 2019, at 19:48.

Feedback

Comment on this article:

blog comments powered by Disqus