Database Administrator (DBA) report discovery
Summarize
Summary of Database Administrator (DBA) report discovery
The Database Administrator (DBA) report discovery feature in ServiceNow's Discovery and Service Mapping leverages Patterns extension sections to gather detailed database metrics for Apache Cassandra, Microsoft SQL Server, MySQL, MongoDB, and Oracle databases. This capability populates specific CI-related tables with database health, performance, and configuration data to enhance your CMDB accuracy and support database management.
Show less
Prerequisites
- Ensure required plugins and applications are installed and updated: CMDB CI Class Models 1.49.0 and Discovery and Service Mapping Patterns 1.8.0 (both as of September 2023).
- Enable the system properties that control DBA report collection per database type. By default, these properties are disabled (false) and must be set to true for each supported database pattern (e.g., cassandradbareportenabled, mongodbareportenabled).
- Verify that appropriate credentials are configured with read access to the necessary database tables and commands for each database type. These credentials should allow queries such as "nodetool" for Cassandra, "getSiblingDB" for MongoDB, and various system views and tables for Microsoft SQL and Oracle databases.
- Confirm a Discovery schedule is set up to run these patterns regularly.
Data Collection and Tables Populated
When the DBA report feature is enabled and Discovery patterns run, the following data is collected and stored in dedicated tables for each database type:
- Apache Cassandra: Captures health metrics like latency, snapshot space, and keyspace details in the cassandrahealthreport table.
- MongoDB: Collects statistics including database size, index info, and object counts in the mongodbstatistics table.
- Microsoft SQL Server: Gathers extensive information such as blocking info, CPU utilization, backup status, running jobs, disk and file space, fragmentation, memory usage, and transaction details across multiple tables like mssqldbblockinginfo, mssqldbcpuutil, and others.
- MySQL: Reports on table schemas and data index size in the mysqltableschemas table.
- Oracle Database: Provides a broad set of metrics covering active and inactive sessions, ASM disk info, CPU usage, instance info, tablespaces, and top queries across multiple tables such as oracleactivesession, oracleasminfo, oraclecpuusage, and more.
Benefits for ServiceNow Customers
- Enables comprehensive database health and performance visibility directly within ServiceNow, assisting DBAs and IT teams in proactive monitoring and troubleshooting.
- Improves CMDB accuracy by enriching CI records with detailed database-specific metrics and status information.
- Supports automated, scheduled data collection to maintain up-to-date database insights without manual intervention.
- Facilitates better decision-making and service impact analysis through enriched configuration data.
Next Steps
- Review and enable the relevant system properties for the database patterns you intend to monitor.
- Configure and validate credentials with appropriate permissions for each database type.
- Schedule Discovery runs to activate periodic data collection and update your CMDB accordingly.
- Consider updating Discovery and Service Mapping Patterns from the ServiceNow Store to access the latest enhancements and new database pattern versions.
Discovery and Service Mapping uses the Patterns extension sections to provide a Database Administrator report (DBA report) for the Apache Cassandra, Microsoft SQL, MySQL, MongoDB, and Oracle databases. The extension sections for each DB pattern populate the related entries tables. Discovering some of these resources may require updating to the latest version of the Discovery and Service Mapping Patterns application from the ServiceNow Store.
Request new or enhanced Patterns on the ServiceNow® Store
Visit the ServiceNow Store to view all the available updates and for information about submitting requests to the store. For cumulative release notes information for all released apps, see the ServiceNow Store version history release notes.
Prerequisites
- Verify the plugins setup
- CMDB CI Class Models 1.49.0 (September 2023)
- Discovery and Service Mapping Patterns 1.8.0 (September 2023)
- Verify the system properties are enabled
- By default, the system properties for DBA reports are set to false. To enable the report collection, verify that the system properties value for each pattern is set to true.
Pattern System property Cassandra cassandra_dba_report_enabled MongoDB mongo_dba_report_enabled MSSQL DB On Windows mssql_dba_report_enabled My SQL server On Windows and Linux mysql_dba_report_enabled Oracle DB oracle_dba_report_enabled - Verify the configuration of the credentials
- For more information, see Applicative credentials.
MongoDB execute command Applicative credentials should have read access to run “getSiblingDB (databaseName)”Apache Cassandra execute command Discovery credentials should have read access to “nodetool”MySQL tables and execute commands Discovery credentials should have read access to: “information_schema.tables”table- run
“show databases”command
Microsoft SQL tables Discovery credentials should have read access to the following tables: - master.sys.databases
- sys.sysprocesses
- sys.dm_os_sys_info
- sys.dm_os_ring_buffers
- msdb.dbo.backupset
- master.dbo.sysdatabases
- master..sysprocesses
- msdb..sysjobactivity
- sys.master_files
- sys.dm_tran_session_transactions
- sys.dm_os_sys_memory
- sys.database_files
Oracle DB tables and execute commands Discovery credentials should have read access to: - Run
“lsnrctl services”and“sqlplus”commands - dba_data_files table
- dba_segments table
- v$database table
- gv$instance table
- dba_hist_osstat table
- dba_hist_snapshot table
- v$asm_disk table
- v$asm_diskgroup table
- dba_audit_session table
- gv$session_longops table
- gv$session table
- gv$sqlarea table
- gv$process table
- Verify that a Discovery schedule is configured
- For more information, see create a discovery schedule
Data collected by the extension section of the Apache Cassandra pattern
| Table name | Table label | Fields |
|---|---|---|
| cassandra_health_report | Cassandra Health Report |
|
Data collected by the extension section of the MongoDB pattern
| Table name | Table label | Fields |
|---|---|---|
| mongo_db_statistics | Mongo DB Statistics |
|
Data collected by the extension section of the MSSQL pattern
| Table name | Table label | Fields |
|---|---|---|
| ms_sql_db_blocking_info | MSSQL DB Blocking Info |
|
| ms_sql_db_cpu_util | MSSQL DB CPU Util |
|
| ms_sql_db_not_backup | MSSQL DB Not BackUp |
|
| ms_sql_db_running_job | MSSQL DB Running Job |
|
| ms_sql_disk_info | MSSQL DB Disks Info |
|
| ms_sql_files_space | MSSQL DB Files Space |
|
| ms_sql_fregment_info | MSSQL DB Fragmentation Info |
|
| ms_sql_last_restart | MSSQL DB Last Restart |
|
| ms_sql_long_trans | MSSQL DB Long Transactions |
|
| ms_sql_memory_info | MSSQL DB Memory Info |
|
| ms_sql_temp_files_space | MSSQL DB Temp Files Space |
|
Data collected by the extension section of the MySQL pattern
| Table name | Table label | Fields |
|---|---|---|
| mysql_table_schemas | MySql Table Schemas |
|
Data collected by the extension section of the Oracle DB pattern
| Table name | Table label | Fields |
|---|---|---|
| oracle_active_session | Oracle Active Session |
|
| oracle_asm_info | Oracle, ASM Disk Info |
|
| oracle_asm_nodes_info | Oracle ASM Nodes Disk Info |
|
| oracle_cpu_usage | Oracle CPU Usage |
|
| oracle_inactive_sessions | Oracle Inactive Sessions |
|
| oracle_instance_info | Oracle Instance Info |
|
| oracle_nodes_info | Oracle Nodes Info |
|
| oracle_table_space | Oracle Table Space |
|
| oracle_top_10_queries | Oracle Top 10 Queries |
|