Configuring Clip database
Clip stores information about received, created and modified incidents in its database for later lookup during the synchronization process and for display in the Clip Web UI. In a CLIP cluster environment, this data is distributed among all cluster members.
The settings for the database can be configured in an optional <database/> tag, which is commented out by default:
For adjusting the database maintenance related attributes, refer to section 4.11.1, "Configuring CLIP database maintenance attributes".
For adjusting the database HA related attributes, refer to section 4.11.2, "Configuring CLIP database HA attributes".
Configuring CLIP database maintenance attributes
The lifetime of all information and the settings for the database maintenance job are configure by means of the following attributes:
- Attribute "
historyRetentionDays
" (optional, default: 7 days): incident pairs that are closed, i.e. either the OMi/NNMi event is closed or the ticket is closed will remain for "historyRetentionDays
" days in the DB and will then be removed from the DB - Attribute "
historyRetentionMaxDays
" (optional, default: 30 days) and Attribute "historyRetentionForceRemove
" (optional, default: "true"):incident pairs older than "historyRetentionMaxDays
" days are removed from the DB regardless of their status ( closed or not ), if "historyRetentionForceRemove
" is set to "true" and no update has been performed in this time period - Attribute "
OMiQueueStatsHistoryRetentionDays
" (optional, default: 7 days): OMi queue statistic data older than "OMiQueueStatsHistoryRetentionDays
" days is removed from the DB - Attribute "
bulkSize
" (optional, default: "500") and "delayBetweenBulksSecs
" (optional, default: "3"): to limit the number of rows to be removed in one transaction from the DB, only "bulkSize
" rows are removed in one step, and the next step is performed after a delay of "delayBetweenBulksSecs
" seconds - Attribute "
MaintSchedInitialDelayMin
" (optional, default: "30") and "MaintSchedRepeatAfterMin
" (optional, default: "600"): the Clip DB Maintenance job to remove data from the DB starts "MaintSchedInitialDelayMin
" minutes after Clip startup and is repeated every "MaintSchedRepeatAfterMin
" minutes. - Attribute "
user
" (optional, default "sa"): The user name to login to the Clip database - Attribute "
passwd
" (optional, default empty String): The password to login to the Clip database. The password can be entered in clear text or as an encrypted value. To encrypt the password, use the password encryptor in the "Configuration" Tab of the Clip Server Web interface.
In order change the default password in the database please follow these steps:
- Open the H2 console http://localhost:9091
- In the field JDBC URL enter: jdbc:h2:tcp://localhost:9092/ClipDB
- Leave the username and password field to its default
- Hit the button "Connect"
- Change the password with the SQL-statement:
ALTER USER SA SET PASSWORD 'password'
- Hit "Run" to change the password
Configuring CLIP database HA attributes
In order to run CLIP in a HA cluster, the following attributes need to be configured:
Attribute “
clusterServer
” (required for HA): (required for HA): this attribute defines all CLIP instances in a CLIP HA cluster. Its value is a comma separated list of all CLIP instances, each instance contained in this list has the form: "[Clip Instance hostname or IP Address]:[DB port (default: 9092)]" .
An example for two CLIP servers running on clipprd1.applink.de and clipprd2.applink.de with a local database and the default DB port is:
- Attribute "
startTcpServer
" (optional, default: starts on port 9092): by default, each CLIP instance starts its local DB on port 9092. This attribute usually does not have to be mentioned or changed in the standard scenario without port conflict ( Example for a non standard port:startTcpServer="9192
"). If attribute "tcpAllowOthers
" is set to "true" hosts other than localhost can access the database. - Attribute "
startWebServer
" (optional, default: starts on port 9091): by default, each CLIP instance starts its local DB Web server on port 9091. This attribute usually does not have to be mentioned or changed in the standard scenario without port conflict ( Example for a non standard port:startWebServer="9191"
, example to disable the DB Web server:startWebServer="0"
). If attribute "webAllowOthers
" is set to "true" the DB-Web interface is accessible by hosts other than localhost.
Other CLIP database maintenance attributes
The data size of some attributes can be significant, e.g. an OMi event's "originalData" attribute can have 500KB if it contains the output of automatic actions for example. Subsequent event updates can further increase the data per event/incident pair if an attribute gets updates frequently with a big amount of data.
As CLIP processes these attributes and stores it into the CLIP DB, the following attributes for the database tag can control attributes of big data:
- Attribute "
maxAttributeSizeChars
" limits the size of an attribute to the configured number of characters for processing, default is 0 which means there is no limit. - Attribute "
maxAttributeSizeCharsDB
" limits the size of an attribute to the configured number of characters for storage in the CLIP DB, default is 4096 characters. - Attribute "
keyLength
" limits the size of a correlation key in the CLIP DB, default is 128 characters. Resizing the key length requires setting a new maximum value ( e.g. keyLength=192 ) and recreation of the database or adjusting the column for the key manually ("ALTER TABLE RLDATA_MASTER ALTER COLUMN KEY VARCHAR(256)").