Zum Hauptinhalt springen

System monitoring

Monitoring information provided by ConSol CM​

Monitoring information can be retrieved using the health check endpoint. The monitoring reports contain information about the configuration of ConSol CM and the operational status of the system components.

Two reports are provided:

  • full report: <CM URL>/health/report
  • short report: <CM URL>/health/check

The information is retrieved in JSON format. Some sections contain a status (SUCCESS, WARNING) with a description.

The following information is retrieved:

  • Workflow engine: number of job execution threads, number of jobs (active, running, locked, delayed, under retry), transaction timeout, locking limit, timestamp of the latest job execution

  • Database: name, version and hibernate dialect, status and speed of test connection, number of available and used connections (only available for JBoss application servers)

  • Database performance: This check needs to be executed manually. It creates a temporary table, generates rows in this table and performs select operations in order to test the performance of the database.

    The check is configured using the following URL parameters:

    • cmas-core-dao-performance.enabled: Determines whether the performance check is enabled. The default value is "false". You need to set this parameter to true to activate the performance check.
    • cmas-core-dao-performance.cleanData: Determines whether the table should be cleared before each run. The default value is "true".
    • cmas-core-dao-performance.threadsNumber: Determines the number of threads used for the performance check. The default value is 10.
    • cmas-core-dao-performance.rowsPerThread: Determines how many rows are generated by each thread. The default value is 5000.
    • cmas-core-dao-performance.selectsPerThread: Determines how many selects are performed by each thread. The default value is 100.

    The syntax for using the URL parameters is:

      <CM URL>/health/report?cmas-core-dao-performance.enabled=true&cmas-core-dao-performance.cleanData=true

    After enabling the check, you need to wait a couple of minutes and then retrieve the report again.

  • Hardware: used and total memory and disk space, number of processors, CPU usage, system load, time since last boot (in seconds)

  • Server information: ConSol CM version, Java version, JavaMail version, status of the SMTP connection, cluster node ID (if the system runs in a cluster)

  • Server events: number of cluster members, timestamp and response to test calls

  • Email system: mailbox ID, number of queued emails, timestamp of the last connection and processed email, ID of the last processed email

  • DWH information: mode, status, date of last transfer, live mode status, date of last live message, statistics

  • License information: number of available and currently used licenses for each license pool, days until the first license expires

  • Authentication protection: protected endpoints, number of failed attempts in the last hour, configuration

Using third-party tools for monitoring​

You can use the monitoring tools of your choice to control your ConSol CM system. Monitoring should cover the application server, the database and the file system.

If you want to perform end-to-end tests, you can create a dedicated monitoring user which does not consume a license. This user can access the respective client once and act according to his permissions. The session created is marked as a monitoring session.

The login of the monitoring user is defined in the system properties.

Web Client:

  1. Create the user in the Web Admin Suite.
  2. Assign him the required roles to grant permissions.
  3. Enter the login of the user in the system property cmas.core.server, monitoring.engineer.login.

CM/Track:

  1. Create the contact in the Web Client.
  2. Assign him the required CM/Track user profile to grant permissions.
  3. Enter the login of the contact in the system property cmas.core.server, monitoring.unit.login.