Skip to content

Detected DB Entities Report

Daniel Odievich edited this page Sep 25, 2018 · 21 revisions

Overview

Detected DB Entities report shows information about each and every detected Entity (Collector Definitions, Collectors, Queries, Users, Sessions, Blocking Sessions, Clients, Databases, Modules, Programs, Wait States and Related Business Transactions) in DB applications.

It is only generated if user requested DB application (ApplicationType=DB) in Target in Job File.

Report File Locations

Detected DB Entities report is produced when Output.DetectedEntities=True and when the DB application was queried.

Detected DB Entities report has the following file format Report\DetectedEntities.DB.<Job File Name>.<Start Date and Time>-<End Date and Time>.xlsx

For example, DetectedEntities.DB.demo1demo2.withSIM.201807202100-201807202110.xlsx

Data File Locations

The data for the report is in the following files:

  • "Report\DBENT\applications.csv"
  • "Report\DBENT\blockingsessions.csv"
  • "Report\DBENT\businesstransactions.csv"
  • "Report\DBENT\clients.csv"
  • "Report\DBENT\collectordefinitions.csv"
  • "Report\DBENT\collectors.csv"
  • "Report\DBENT\databases.csv"
  • "Report\DBENT\modules.csv"
  • "Report\DBENT\programs.csv"
  • "Report\DBENT\queries.csv"
  • "Report\DBENT\sessions.csv"
  • "Report\DBENT\users.csv"
  • "Report\DBENT\waitstates.csv"

Report Contents

Data Pivot
1.Parameters
2.Contents
3.Controllers
4.Appplications
5.Collector Definitions
6.Collectors 6.Collectors.Type
7.Queries 7.Queries.Type
8.Users 8.Users.Type
9.Sessions 9.Sessions.Type
10.Blocking Sessions
11.Clients 11.Clients.Type
12.Databases 12.Databases.Type
13.Modules 13.Modules.Type
14.Programs 14.Programs.Type
15.BTs
16.Wait States 16.Wait States.Type

1.Parameters

This sheet describes the parameters of the extraction and reporting job that produced this report.

Column Data Type Purpose
Controller URL Controller that was queried
UserName String User that was used to retrieve data from the Controller
Application String Name of Application that was queried
ApplicationID Integer ID of Application in Controller

2.Contents

This sheet provides quick access to the contents of this report and provides at-a-glance number of rows in each of the sheet’s tables.

Column Data Type Purpose
Sheet Name String Name of the sheet in the report
Num Entities Integer Number of Entities in that sheet
Link Hyperlink Link to the sheet in the report

3.Controllers

This sheet provides information about Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
UserName String User that was used to retrieve data from the Controller
Version String Version of the Controller
NumApps Integer Number of APM Applications registered in the Controller
ControllerLink URL Link to Controller

4.Applications

This sheet provides information about all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
ApplicationName String Name of Application
Description String Description of Application, if set
NumCollectorDefinitions Integer Number of Collector Definitions configured
NumCollectors Integer Number of Collectors that are detected
NumOracle Integer Number of Oracle Collectors
NumMySQL Integer Number of MySQL Collectors
NumSQLServer Integer Number of SQL Server Collectors
NumDB2 Integer Number of DB2 Collectors
NumPostgres Integer Number of Postres Collectors
NumSybase Integer Number of Sybase Collectors
NumOther Integer Number of Other Collectors
ControllerLink URL Link to Controller
ApplicationLink URL Link to Application in Controller

5.Collector Definitions

This sheet provides information about all Collector Definitions in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
IsEnabled Boolean Is this Collector enabled
IsLoggingEnabled Boolean Is logging enabled on this Collector
DatabaseName String Not sure what this is for
FailoverPartner String Not sure what this is for
SID String SID or Service Name to use to connect
CustomConnectionString String Custom database connection string specified for Collector
UseWindowsAuth Boolean Use Windows Authentication to connect to database. SQL Server only
ConnectAsSysDBA Boolean Connect as SysDBA user. Oracle only
UseServiceName Boolean Use Service Name to connect. Oracle only (?)
UseSSL Boolean Use SSL connectivity to OS (?)
IsEnterpriseDB Boolean Not sure what this means
IsOSMonitoringEnabled Boolean Is OS Monitoring enabled
UseWindowsAuth Boolean Not sure what this is for
UseLocalWMI Boolean Use Local WMI to collect OS hardware information. Windows only
HostOS String Host Operating System
HostDomain String Host Domain
HostUserName String Username for Host OS monitoring
UseCertificateAuth Boolean Use certificate authentication for OS harware monitoring
SSHPort Integer Port for SSH login for OS monitoring
DBInstanceID Integer Not sure what this is for
Region String Not sure what this is
RemoveLiterals Boolean Not sure what this is
IsLDAPEnabled Boolean Not sure what this is
CreatedBy String Who created this Collector
CreatedOn DateTime When was this Collector created
ModifiedBy String Who last modified this Collector
ModifiedOn DateTime When was this Collector last modified
ConfigID Integer ID of Collector Definition
ControllerLink URL Link to Controller
ApplicationLink URL Link to Application in Controller

6.Collectors

This sheet provides information about all Collectors in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
Role String Database role as reported by Database Monitoring agent
Calls Number Number of calls to this entity
ExecTime Number Duration of execution of all calls to this entity
ExecTimeSpan TimeSpan Duration of execution of all calls to this entity
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
ControllerLink URL Link to Controller
ApplicationLink URL Link to Application in Controller
CollectorLink URL Link to Collector in Controller

6.Collectors.Type

This sheet uses data in 6.Collectors sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.

Default configuration provides breakdown of Database Collectors by type in all Controllers, summarized by their reporting status.

Columns Rows Values Filters
CollectorStatus
CollectorType
Controller
CollectorName
Host
NumCollections (Count)
Calls (Sum)
ExecTime (Average)
AgentName

Example report showing various types of database collectors across 2 controllers

Full Size

Here is the report that is filtered to specific Database Agent instance, and only showing collectors that are actually collecting data from Mongo and Oracle databases

Full Size

7.Queries

This sheet provides information about all Queries in all Collectors in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
QueryHash String Hash of query
Query String Query that was executed
SQLClauseType String Type of SQL clause DML: SELECT, INSERT, UPDATE, DELETE, TRUNCATE; DDL: CREATE, ALTER, DROP; Security: GRANT, REVOKE; Stored Procedures: PROCCALL
SQLJoinType String Join types: INNER, LEFT, RIGHT, FULL, SELF, CROSS
SQLGroupBy Boolean Whether GROUP BY clause is present
SQLHaving Boolean Whether HAVING clause is present
SQLOrderBy Boolean Whether ORDER BY clause is present
SQLUnion Boolean Whether UNION clause is present
SQLWhere Boolean Whether WHERE clause is present
Name String Name of the query. Mostly appears to be blank
Namespace String Namespace of the query. Mostly appears to be blank
Client String Not sure what that is
Calls Number Number of calls to this entity
ExecTime Number Duration of execution of all calls to this entity
ExecTimeSpan TimeSpan Duration of execution of all calls to this entity
AvgExecTime Number Average duration of execution for single call to this entity
AvgExecRange String String representing bucket into which Duration fits
Weight Number Percentage of these executions against all others
IsSnapCorrData Boolean Not sure what this is
IsSnapWindowData Boolean Not sure what this is
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
QueryID Integer ID of Query
ControllerLink URL Link to Controller
ApplicationLink URL Link to Application in Controller
CollectorLink URL Link to Collector in Controller
QueryLink URL Link to Query in Controller

7.Queries.Type

This sheet uses data in 7.Queries sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.

Default configuration provides breakdown of various query types by Number of Calls, Execution time and Weight across all Controllers and Collectors.

Columns Rows Values Filters
SQLClauseType
Query
CollectorType
Controller
CollectorName
Host
NumQueries (Count)
Calls (Sum)
AvgExecTime (Average)
Weight (Average)
AgentName
SQLJoinType
SQLGroupBy
SQLHaving
SQLOrderBy
SQLUnion
SQLWhere

Example report showing all types of queries from couple of dozen of various databases, grouped by their SQL clause type

Full Size

Here is the report that is filtered to to only SELECT queries that contain WHERE statement and sorted by number of Calls

Full Size

8.Users

This sheet provides information about all Users in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
DBUserName String Database user name that is executing queries
ExecTime Number Duration of execution of all calls to this entity
ExecTimeSpan TimeSpan Duration of execution of all calls to this entity
Weight Number Percentage of these executions against all others
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
UserID Integer ID of User

8.Users.Type

This sheet uses data in 8.Users sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.

Default configuration provides breakdown of Users querying databases by Number of Calls, Execution time and Weight across all Controllers and Collectors.

Columns Rows Values Filters
CollectorType
DBUserName
Controller
CollectorName
Host
NumUsers (Count)
ExecTime (Average)
Weight (Average)
AgentName

Example report showing all users by type of database in all database collectors

Full Size

9.Sessions

This sheet provides information about all Sessions in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
SessionName String Session name of the session executing queries
ClientName String Client within the the session executing queries
ExecTime Number Duration of execution of all calls to this entity
ExecTimeSpan TimeSpan Duration of execution of all calls to this entity
Weight Number Percentage of these executions against all others
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
SessionID Integer ID of Session

9.Sessions.Type

This sheet uses data in 9.Sessions sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.

Default configuration provides breakdown of Sessions with clients accessing databases by Number of Calls, Execution time and Weight across all Controllers and Collectors.

Columns Rows Values Filters
CollectorType
ClientName
SessionName
Controller
CollectorName
Host
NumSessions (Count)
ExecTime (Average)
Weight (Average)
AgentName

Example report showing all clients and sessions by type of database in all database collectors

Full Size

10.Blocking Sessions

This sheet provides information about all Blocking Sessions in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
BlockingSessionName String Session name of the session that is blocking
BlockingClientName String Client within the the session executing queries that is blocking
BlockingDBUserName String Database user name of the Session that is blocking
OtherSessionName String Session name of the session that is blocked
OtherClientName String Client within the the session executing queries that is blocked
OtherDBUserName String Database user name of the Session that is blocked
QueryHash String Hash of query
Query String Query that was executed
BlockTime Number Duration of blocked time
ExecTimeSpan TimeSpan Duration of blocked time
Weight Number Percentage of these executions against all others
FirstOccurrence DateTime Beginning of first occurrence, local time
FirstOccurrenceUtc DateTime Beginning of first occurrence, UTC time
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
BlockingSessionID Integer ID of Blocking Session

11.Clients

This sheet provides information about all Clients in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
ClientName String Client executing queries
ExecTime Number Duration of execution of all calls to this entity
ExecTimeSpan TimeSpan Duration of execution of all calls to this entity
Weight Number Percentage of these executions against all others
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
ClientID Integer ID of Client

11.Clients.Type

This sheet uses data in 11.Clients sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.

Default configuration provides breakdown of Clients accessing databases by Number of Calls, Execution time and Weight across all Controllers and Collectors.

Columns Rows Values Filters
CollectorType
ClientName
Controller
CollectorName
Host
NumClients (Count)
ExecTime (Average)
Weight (Average)
AgentName

Example report showing all clients by type of database in all database collectors

Full Size

12.Databases

This sheet provides information about all Databases in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
DatabaseName String Database being queried
ExecTime Number Duration of execution of all calls to this entity
ExecTimeSpan TimeSpan Duration of execution of all calls to this entity
Weight Number Percentage of these executions against all others
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
DatabaseID Integer ID of Database

12.Databases.Type

This sheet uses data in 12.Databases sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.

Default configuration provides breakdown of Databases by Number of Calls, Execution time and Weight across all Controllers and Collectors.

Columns Rows Values Filters
CollectorType
DatabaseName
Controller
CollectorName
Host
NumDBs (Count)
ExecTime (Average)
Weight (Average)
AgentName

Example report showing all database by type of database in all database collectors

Full Size

13.Modules

This sheet provides information about all Modules in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
ModuleName String Module being invoked
ExecTime Number Duration of execution of all calls to this entity
ExecTimeSpan TimeSpan Duration of execution of all calls to this entity
Weight Number Percentage of these executions against all others
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
ModuleID Integer ID of Module

13.Modules.Type

This sheet uses data in 13.Modules sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.

Default configuration provides breakdown of Modules by Number of Calls, Execution time and Weight across all Controllers and Collectors.

Columns Rows Values Filters
CollectorType
ModuleName
Controller
CollectorName
Host
NumModules (Count)
ExecTime (Average)
Weight (Average)
AgentName

Example report showing all modules by type of database in all database collectors

Full Size

14.Programs

This sheet provides information about all Programs in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
ProgramName String Program being invoked
ExecTime Number Duration of execution of all calls to this entity
ExecTimeSpan TimeSpan Duration of execution of all calls to this entity
Weight Number Percentage of these executions against all others
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
ProgramID Integer ID of Program

14.Programs.Type

This sheet uses data in 14.Programs sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.

Default configuration provides breakdown of Programs by Number of Calls, Execution time and Weight across all Controllers and Collectors.

Columns Rows Values Filters
CollectorType
ProgramName
Controller
CollectorName
Host
NumPrograms (Count)
ExecTime (Average)
Weight (Average)
AgentName

Example report showing all programs by type of database in all database collectors

Full Size

15.BTs

This sheet provides information about all Wait States in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
ApplicationName String APM Application that contains Business Transactions that call this Database
BTName String APM Business Transaction that call this Database
ExecTime Number Duration of execution of all calls to this entity
ExecTimeSpan TimeSpan Duration of execution of all calls to this entity
AvgExecTime Number Average duration of execution for single call to this entity
AvgExecRange String String representing bucket into which Duration fits
Weight Number Percentage of these executions against all others
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
ApplicationID Integer ID of Application in Controller
BTID Integer ID of Business Transaction in Application

16.Wait States

This sheet provides information about all Wait States in all DB Applications in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
CollectorName String Name of Collector
CollectorType String Type of Collector
CollectorStatus String Status of Collector
AgentName String Name of Database Agent that is assigned to serve this Collector
Host String Hostname of the database server
Port Integer Port of the database server
UserName String User name of the user used to access the database server
State String Wait State name
ExecTime Number Duration of execution of all calls to this entity
ExecTimeSpan TimeSpan Duration of execution of all calls to this entity
Weight Number Percentage of these executions against all others
From DateTime Beginning of time range queried, local time
To DateTime End of time range queried, local time
FromUtc DateTime Beginning of time range queried, UTC time
ToUtc DateTime End of time range queried, UTC time
Duration Integer Duration of time range queried, in minutes
ConfigID Integer ID of Collector Definition
CollectorID Integer ID of Collector
WaitStateID Integer ID of Wait State

16.Wait States.Type

This sheet uses data in 16.Wait States sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.

Default configuration provides breakdown of Wait States by Number of Calls, Execution time and Weight across all Controllers and Collectors.

Columns Rows Values Filters
CollectorType
State
Controller
CollectorName
Host
NumWaitStates (Count)
ExecTime (Average)
AgentName

Example report showing all wait states by type of database in all database collectors

![](../blob/master/docs/reports/DetectedEntitiesDB/16.Wait States.Type.png?raw=true) [Full Size](../blob/master/docs/reports/DetectedEntitiesDB/16.Wait States.Type.png?raw=true)

Clone this wiki locally