Database Administrator (DBA) report discovery
Summarize
Summary of Database Administrator (DBA) report discovery
The Database Administrator (DBA) report discovery feature in the Zurich release enables ServiceNow customers to gather detailed database health and performance data for Apache Cassandra, Microsoft SQL, MySQL, MongoDB, and Oracle databases. This functionality is provided through extension sections in Discovery and Service Mapping Patterns, which populate related entries tables in the CMDB.
Show less
To access the latest capabilities, customers may need to update the Discovery and Service Mapping Patterns application from the ServiceNow Store. This ensures the discovery patterns have current enhancements and fixes.
Prerequisites
- Required plugins: CMDB CI Class Models 1.49.0 and Discovery and Service Mapping Patterns 1.8.0 (both from September 2023).
- Enable system properties: By default, DBA report collection is disabled. Customers must set the specific system property for each database pattern to true to enable data collection (e.g.,
cassandradbareportenabledfor Cassandra). - Credentials configuration: Discovery and applicative credentials require appropriate read permissions for each database type to execute necessary commands and query system tables for data collection.
- Discovery schedule: A configured discovery schedule is needed to run the database discovery patterns regularly.
Data Collection and Tables
When enabled, each database pattern collects specific sets of data and populates tables with key metrics and health indicators relevant to database administrators. Below are the key data collected per database type:
- Apache Cassandra: Health metrics such as local write latency, read latency, and snapshot space usage stored in the
cassandrahealthreporttable. - MongoDB: Database statistics including size metrics, index counts, and object counts stored in the
mongodbstatisticstable. - Microsoft SQL Server: Extensive data on blocking info, CPU utilization, backup status, running jobs, disk and file space, fragmentation, restarts, long transactions, memory, and temp file usage in multiple specialized tables (e.g.,
mssqldbblockinginfo,mssqldbcpuutil). - MySQL: Schema and table size information stored in the
mysqltableschemastable. - Oracle DB: Comprehensive data including active sessions, ASM disk info, CPU usage, inactive sessions, instance info, nodes info, tablespace usage, and top queries across various tables such as
oracleactivesession,oracleasminfo, andoracletop10queries.
Practical Benefits for ServiceNow Customers
This discovery feature empowers ServiceNow customers to:
- Automatically collect and maintain up-to-date, detailed database health and performance data within the CMDB.
- Gain visibility into critical database metrics for proactive monitoring and troubleshooting.
- Leverage this data for improved database administration, capacity planning, and compliance reporting.
- Ensure discovery accuracy by properly configuring credentials and enabling relevant system properties.
By integrating DBA report data into ServiceNow's Discovery and CMDB, organizations can streamline IT operations and improve service reliability related to their database environments.
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 |
|