Smile CDR v2022.11.PRE

On this page:

38.17 Smile CDR License 38.19 Message Broker

38.18Cluster Manager Maintenance

The Cluster Manager Maintenance configuration category includes the following configurable options:

Audit Log Broker Channel Name
Audit Log Broker Enabled
Audit Log Database Async Writes
Audit Log Database Enabled
Request headers to store
Stats Retention (Days) - Day Level
Stats Retention (Days) - Hour Level
Stats Retention (Days) - Minute Level
Transaction Log Retention (Days)
Scheduler Thread Count
Persist Runtime Monitoring Statistics Enabled
Heartbeat Persist Frequency MS
Stats Cleanup Frequency MS
Stats Persist Frequency MS

38.18.1Property: Audit Log Broker Channel Name

Property Name	Audit Log Broker Channel Name
Property Key
Property Type	STRING
Description	The audit logs will be sent to the specified topic/queue name. Must be non-empty.
Applies to Modules	Cluster Manager
Default Value	`smilecdr-audit`
Example Property	`module.[MODULE_ID].config.audit_log.broker.channel_name = smilecdr-audit`

38.18.2Property: Audit Log Broker Enabled

Property Name	Audit Log Broker Enabled
Property Key
Property Type	BOOLEAN
Description	This setting may be used to submit all audit log events to a message queue.
Applies to Modules	Cluster Manager
Default Value	`false`
Example Property	`module.[MODULE_ID].config.audit_log.broker.enabled = false`

38.18.3Property: Audit Log Database Async Writes

Property Name	Audit Log Database Async Writes
Property Key
Property Type	BOOLEAN
Description	If enabled, writing to the audit log will be performed asynchronously, resulting in potentially shorter transaction times and a more efficient use of the database. An in-memory asynchronous queue is used, meaning that there can be a small delay between an auditable action occurring and the audit log being written.
Applies to Modules	Cluster Manager
Default Value	`false`
Example Property	`module.[MODULE_ID].config.audit_log.db.async_writes.enabled = false`

38.18.4Property: Audit Log Database Enabled

Property Name	Audit Log Database Enabled
Property Key
Property Type	BOOLEAN
Description	This setting may be used to disable saving audit logs to a database if it is not needed in a given solution design.
Applies to Modules	Cluster Manager
Default Value	`true`
Example Property	`module.[MODULE_ID].config.audit_log.db.enabled = true`

38.18.5Property: Request headers to store

Property Name	Request headers to store
Property Key
Property Type	STRING
Description	This setting can be set to a comma-delimited list of header names that the audit service will extract from the request and store with any Audit Log.
Applies to Modules	Cluster Manager
Default Value	(no default)
Example Property	`module.[MODULE_ID].config.audit_log.request_headers_to_store =`

38.18.6Property: Stats Retention (Days) - Day Level

Property Name	Stats Retention (Days) - Day Level
Property Key
Property Type	NON_NEGATIVE_INTEGER
Description	The number of days that statistics at the day precision will be retained.
Applies to Modules	Cluster Manager
Default Value	`365`
Example Property	`module.[MODULE_ID].config.retain_day_stats_days = 365`

38.18.7Property: Stats Retention (Days) - Hour Level

Property Name	Stats Retention (Days) - Hour Level
Property Key
Property Type	NON_NEGATIVE_INTEGER
Description	The number of days that statistics at the hour precision will be retained.
Applies to Modules	Cluster Manager
Default Value	`31`
Example Property	`module.[MODULE_ID].config.retain_hour_stats_days = 31`

38.18.8Property: Stats Retention (Days) - Minute Level

Property Name	Stats Retention (Days) - Minute Level
Property Key
Property Type	NON_NEGATIVE_INTEGER
Description	The number of days that statistics at the minute precision will be retained.
Applies to Modules	Cluster Manager
Default Value	`7`
Example Property	`module.[MODULE_ID].config.retain_minute_stats_days = 7`

38.18.9Property: Transaction Log Retention (Days)

Property Name	Transaction Log Retention (Days)
Property Key
Property Type	NON_NEGATIVE_INTEGER
Description	The number of days that entries in the transaction log should be retained before being deleted from the database. If blank, the transaction log will be retained indefinitely.
Applies to Modules	Cluster Manager
Default Value	`90`
Example Property	`module.[MODULE_ID].config.retain_transaction_log_days = 90`

38.18.10Property: Scheduler Thread Count

Property Name	Scheduler Thread Count
Property Key
Property Type	POSITIVE_INTEGER
Description	The number of threads allocated to processing cluster-wide scheduled background tasks. All nodes share the same pool of clustered tasks.
Applies to Modules	Cluster Manager
Default Value	`4`
Example Property	`module.[MODULE_ID].config.schedule.thread_count = 4`

38.18.11Property: Persist Runtime Monitoring Statistics Enabled

Property Name	Persist Runtime Monitoring Statistics Enabled
Property Key
Property Type	BOOLEAN
Description	If this is enabled, runtime monitoring statistics will be periodically stored in the database.
Applies to Modules	Cluster Manager
Default Value	`true`
Example Property	`module.[MODULE_ID].config.scheduled_jobs.persist_runtime_monitoring_statistics.enabled = true`

38.18.12Property: Heartbeat Persist Frequency MS

Property Name	Heartbeat Persist Frequency MS
Property Key
Property Type	POSITIVE_INTEGER
Description	How often module health status is persisted to the database
Applies to Modules	Cluster Manager
Default Value	`15000`
Example Property	`module.[MODULE_ID].config.stats.heartbeat_persist_frequency_ms = 15000`

38.18.13Property: Stats Cleanup Frequency MS

Property Name	Stats Cleanup Frequency MS
Property Key
Property Type	POSITIVE_INTEGER
Description	How often module performance statistics are deleted from the database and collapsed into time interval statistics. Should be greater than stats.stats_persist_frequency_ms
Applies to Modules	Cluster Manager
Default Value	`300000`
Example Property	`module.[MODULE_ID].config.stats.stats_cleanup_frequency_ms = 300000`

38.18.14Property: Stats Persist Frequency MS

Property Name	Stats Persist Frequency MS
Property Key
Property Type	POSITIVE_INTEGER
Description	How often module performance statistics are persisted to the database. Should be greater than or equal to stats.heartbeat_persist_frequency_ms
Applies to Modules	Cluster Manager
Default Value	`60000`
Example Property	`module.[MODULE_ID].config.stats.stats_persist_frequency_ms = 60000`

38.17 Smile CDR License 38.19 Message Broker