System Config Endpoint

 

The System Config endpoint can be used to access information about the system and configuration for debugging purposes.

This method requires the VIEW_MODULE_CONFIG permission.

This method will return a zip file containing:

  • Version and build information
  • Smile CDR configuration with sensitive information and scripts redacted
  • Node statuses
  • Processor count and memory information of the JVM
  • A thread dump
  • A summary of all hooks registered on pointcuts
  • Log files (when includeLogs=true) — see Retrieving Logs. Only the active file for each log is included; historical rolled-over files are not
  • Database statistics for each module with a datasource (when includeDbStats=true)

To invoke:

GET http://localhost:9000/system-config?includeLogs=true&includeDbStats=true

Query Parameters

The endpoint accepts the following optional query parameters:

ParameterTypeDefaultDescription
includeLogsbooleanfalseIf set to true, all log files configured by Smile CDR will be bundled into the zip. Note that this can take a long time if your logs are large.
includeDbStatsbooleanfalseIf set to true, database statistics will be collected for each module that has a datasource.

Database Statistics

When includeDbStats=true, the system will collect comprehensive database statistics from each module that has a datasource, including:

  • Database product name and version
  • JDBC driver information
  • Connection pool statistics (active, idle, total connections)
  • Top 20 largest tables by size (with row counts where available)
  • All indexes by size with metadata
  • Database settings and configuration parameters
  • Vacuum/maintenance statistics (PostgreSQL)
  • Table statistics with maintenance info
  • Database-specific diagnostics

Database Support

Database statistics collection supports the following database engines:

  • PostgreSQL
  • Oracle Database
  • Microsoft SQL Server
  • H2 Database

For each supported database, the system collects engine-specific metrics and statistics using appropriate system tables and views.

Output Format

Database statistics are included in the ZIP file as separate text files for each module that has a datasource:

  • database-stats-clustermgr.txt - Statistics for the cluster manager database
  • database-stats-persistence.txt - Statistics for the persistence module database
  • database-stats-audit.txt - Statistics for the audit module database (if configured)
  • database-stats-transaction.txt - Statistics for the transaction log database (if configured)
  • Additional files for any other modules with datasources

Each file contains human-readable statistics formatted as plain text, including timestamps, query execution times, and any errors encountered during collection.

Note that logs and database statistics can contain PHI depending on your setup. Always verify all logs and statistics files to ensure they are stripped of PHI before sending them to Smile CDR for analysis.

Note: System config endpoint added in 2021.05.R02. Database statistics feature added in 2026.05.