[Index]

Model: data/SystemMonitoringConfig

System Monitoring Configuration

A sysadmin administrator can access the System Monitoring menu (menu model: data/SystemMonitoringConfig) to manage:

Default values are set in an instance called Global.

Alerts

From the Alerts tab on the Configuration menu, the following settings and options can be managed:

For the configured alerts, SNMP traps are generated upon failue of the transaction. Refer to the System Monitoring SNMP topic in the Platform Guide for details and examples of the traps.

Metrics Collection

The Metric Collection tab shows:

Configuration for various system monitoring settings and thresholds for alert generation.

Model Details

Title Description Details
Name *
  • Field Name: name
  • Type: String
  • MaxLength: 64
Alerts Configuration for various alert generation conditions.
  • Field Name: alerts
  • Type: Object
Database Stores thresholds for database metrics
  • Field Name: database
  • Type: Object
Database Size Threshold (GB) The threshold at which DB size (in gigabytes) starts generating notifications.
  • Field Name: alerts.database.total_size
  • Type: Integer
Database Index Size Threshold (GB) The threshold at which DB index size (in gigabytes) starts generating notifications.
  • Field Name: alerts.database.total_index_size
  • Type: Integer
Transactions Specifies configuration for alert generation on transactions.
  • Field Name: transactions
  • Type: Object
Transaction Queue Size Threshold The threshold at which transaction queue size starts generating notifications.
  • Field Name: alerts.transactions.queue_size
  • Type: Integer
On Failure List of transactions for which an alert must be sent on failure.
  • Field Name: on_failure.[n]
  • Type: Array
Entity Type Type of an entity for which an alert is required such as model, view, or tool. Wildcards are permitted e.g. data/* applies to all data models. Specific types take precedence over wildcards
  • Field Name: alerts.transactions.on_failure.[n].entity_type
  • Type: String
  • Format: uri
Operations The operations for which alerts are required
  • Field Name: operations.[n]
  • Type: Array
Metric Configuration Stores settings for configurable metrics
  • Field Name: metric_configuration
  • Type: Object
Resource Count by Hierarchy Settings for Resource Count by Hierarchy metric.
  • Field Name: resource_count_by_hierarchy
  • Type: Object
Model Types List of model types that are to be aggregated by hierarchy.
  • Field Name: model_types.[n]
  • Type: Array
Model Type Name of a model type e.g. data/User
  • Field Name: metric_configuration.resource_count_by_hierarchy.model_types.[n].model_type
  • Type: String
RIS API data collector interval Interval in seconds between attempts to run the RIS API data collector
  • Field Name: metric_configuration.risapi_collector_interval
  • Type: Integer
RIS API excluded device types Devices to ignore in RIS API responses
  • Field Name: risapi_excluded_device_types.[n]
  • Type: Array
Monitor external devices Enable monitoring of connectivity to external devices e.g. UC apps
  • Field Name: metric_configuration.monitor_external_devices
  • Type: Boolean
API reference for data/SystemMonitoringConfig