Detected APM Entities Report

Overview

Detected Entities report shows information about each and every detected Entity (Application, Tier, Node, Business Transaction, Backend, Service Endpoint, Errors and Information Point) in APM applications.

Report File Locations

Detected Entities report is produced when Output.DetectedEntities=True. It uses detected metadata data that is always extracted.

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

For example, DetectedEntities.demo2Ecommerce.2017091914-2017091916.xlsx

Data File Locations

The data for the report is in the following files:

• Report\ENT\applications.csv
• Report\ENT\backends.csv
• Report\ENT\businesstransactions.csv
• Report\ENT\controllers.csv
• Report\ENT\errors.csv
• Report\ENT\nodes.csv
• Report\ENT\serviceendpoints.csv
• Report\ENT\tiers.csv

If Controller is 4.4 or later:

• Report\ENT\nodeenvironmentvariables.csv
• Report\ENT\nodeproperties.csv
• Report\ENT\nodestartupoptions.csv

Data Schema

Full Size

Report Contents

Data	Pivot
1.Parameters
2.Contents
3.Controllers
4.Appplications
5.Tiers	5.Tiers.Type
6.Nodes	6.Nodes.Type.AppAgent 6.Nodes.Type.MachineAgent
6.Node Startup Options	6.Node Startup Options.Type 6.Node Startup Options.Location
6.Node VM Properties	6.Node VM Properties.Type 6.Node VM Properties.Location
6.Node Env Variables	6.Node Env Variables.Type 6.Node Env Variables.Location
7.Backends	7.Backends.Type
8.BTs	8.BTs.Type 8.BTs.Location
9.SEPs	9.SEPs.Type 9.SEPs.Location
10.Errors	10.Errors.Type 10.Errors.Location
11.Information Points	11.Information Points.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 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
NumTiers	Integer	Number of Tiers in Application. Can be 0 if Application wasn’t in the list of Applications to query
NumNodes	Integer	Number of Nodes in Application. Can be 0 if Application wasn’t in the list of Applications to query
NumBackend	Integer	Number of Backends in Application. Can be 0 if Application wasn’t in the list of Applications to query
NumBTs	Integer	Number of Business Transactions in Application. Can be 0 if Application wasn’t in the list of Applications to query
NumSEPs	Integer	Number of Service Endpoints in Application. Can be 0 if Application wasn’t in the list of Applications to query
NumErrors	Integer	Number of Errors in Application. Can be 0 if Application wasn’t in the list of Applications to query
NumIPs	Integer	Number of Information Points in Application. Can be 0 if Application wasn’t in the list of Applications to query
ApplicationID	Integer	ID of Application in Controller
DetailLink	Hyperlink	Link to the Entity Details report
MetricGraphLink	HyperLink	Link to the Entity Metric Graphs report
FlameGraphLink	Hyperlink	Link to the Flame Graph report
FlameChartLink	Hyperlink	Link to the Flame Chart report
ControllerLink	URL	Link to Controller
ApplicationLink	URL	Link to Application in Controller

5.Tiers

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

Column	Data Type	Purpose
Controller	URL	Controller that was queried
ApplicationName	String	Name of Application
TierName	String	Name of Tier
TierType	String	Type of Tier
Description	String	Description of Tier, if set
AgentType	String	Type of Agent reporting to this Tier
NumNodes	Integer	Number of Nodes in Tier
NumBTs	Integer	Number of Business Transactions in Application
NumSEPs	Integer	Number of Service Endpoints in Application
NumErrors	Integer	Number of Errors in Application
ApplicationID	Integer	ID of Application in Controller
TierID	Integer	ID of Tier in Application
DetailLink	Hyperlink	Link to the Entity Details report
MetricGraphLink	HyperLink	Link to the Entity Metric Graphs report
FlameGraphLink	Hyperlink	Link to the Flame Graph report
FlameChartLink	Hyperlink	Link to the Flame Chart report
ControllerLink	URL	Link to Controller
ApplicationLink	URL	Link to Application in Controller
TierLink	URL	Link to Tier in Controller

5.Tiers.Type

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

Default configuration provides breakdown of APM Agents by AgentType in all Controllers, Applications and Tiers.

Columns	Rows	Values	Filters
AgentType
	Controller
	ApplicationName
		TierName (Count)

Example report showing Application with Node.js, Java and .NET APM agents:

Full Size

6.Nodes

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

Column	Data Type	Purpose
Controller	URL	Controller that was queried
ApplicationName	String	Name of Application
TierName	String	Name of Tier
NodeName	String	Name of Node
AgentType	String	Type of APM Agent
AgentVersion	String	Version of APM Agent, parsed to #.#.#.#
AgentVersionRaw	String	Version of APM Agent as reported to Controller
AgentPresent	Boolean	Whether APM Agent is present
MachineName	String	Machine Name as reported by Machine Agent
MachineAgentVersion	String	Version of Machine Agent, parsed to #.#.#.#
MachineAgentVersionRaw	String	Version of Machine Agent as reported to Controller
MachineAgentPresent	Boolean	Whether Machine Agent is present
MachineOSType	String	Type of the OS where Machine Agent is running
MachineType	String	Type of the Machine where Machine Agent is running
AgentRuntime	String	Java runtime name and version
InstallDirectory	String	Install directory of the agent
InstallTime	DateTime	Datetime of the installation
LastStartTime	DateTime	Datetime of last agent start
IsDisabled	Boolean	Whether the agent is disabled. Never seen it true. Not sure if used.
IsMonitoringDisabled	Boolean	Whether the agent monitoring is disabled. Never seen it true. Not sure if used.
NumStartupOptions	Integer	Number of JVM startup options for this node
NumProperties	Integer	Number of JVM options for this node
NumEnvVariables	Integer	Number of environment variables for this node
ApplicationID	Integer	ID of Application in Controller
TierID	Integer	ID of Tier in Application
NodeID	Integer	ID of APM Agent in Application
MachineID	Integer	ID of Machine Agent in Application
DetailLink	Hyperlink	Link to the Entity Details report
MetricGraphLink	HyperLink	Link to the Entity Metric Graphs report
FlameGraphLink	Hyperlink	Link to the Flame Graph report
FlameChartLink	Hyperlink	Link to the Flame Chart report
ControllerLink	URL	Link to Controller
ApplicationLink	URL	Link to Application in Controller
TierLink	URL	Link to Tier in Controller
NodeLink	URL	Link to Node in Controller

6.Nodes.Type.AppAgent

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

Default configuration provides breakdown of APM Agents by AgentType and AgentVersion in all Controllers, Applications and Tiers.

Columns	Rows	Values	Filters
AgentType
AgentVersion
	Controller
	ApplicationName
	TierName
	NodeName
		NodeName (Count)
			AgentPresent

Example report showing Application with Java and .NET APM agents and their versions. This customer needs to upgrade those old agents:

Full Size

6.Nodes.Type.MachineAgent

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

Default configuration provides breakdown of Machine Agents by AgentVersion in all Controllers, Applications and Tiers.

Columns	Rows	Values	Filters
AgentType
MachineAgentVersion
	Controller
	ApplicationName
	TierName
	MachineName
		NodeName (Count)
			MachineAgentPresent

Example report showing Application with Machine Agents of various ages:

Full Size

6.Node Startup Options

This sheet provides information about all startup options for Nodes in all Tiers in all Applications in all Controllers covered by this report.

Column	Data Type	Purpose
Controller	URL	Controller that was queried
ApplicationName	String	Name of Application
TierName	String	Name of Tier
NodeName	String	Name of Node
AgentType	String	Type of APM Agent
PropName	String	Name of option
PropValue	String	Value of option
ApplicationID	Integer	ID of Application in Controller
TierID	Integer	ID of Tier in Application
NodeID	Integer	ID of APM Agent in Application

6.Node Startup Options.Type

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

Default configuration provides breakdown of startup options and their values for each APM Agents by AgentType and AgentVersion in all Controllers, Applications and Tiers.

Columns	Rows	Values	Filters
AgentType
	Controller
	ApplicationName
	TierName
	NodeName
	PropName
	PropValue
		NodeName (Count)

Example report showing Applications with startup options starting with "java":

Full Size

6.Node Startup Options.Location

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

Default configuration provides breakdown of startup options and their values used by APM Agents by AgentType and AgentVersion in all Controllers, Applications and Tiers.

Columns	Rows	Values	Filters
AgentType
	PropName
	PropValue
	Controller
	ApplicationName
	TierName
	NodeName
		NodeName (Count)

Example report showing all unique values for with startup options starting with "java" and which applications they belong to:

Full Size

6.Node VM Properties

This sheet provides information about all JVM options for Nodes in all Tiers in all Applications in all Controllers covered by this report.

Structure is identical to 6.Node Startup Options

6.Node VM Properties.Type

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

Structure is identical to 6.Node Startup Options.Type

6.Node VM Properties.Location

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

Structure is identical to 6.Node Startup Options.Location

6.Node Env Variables

This sheet provides information about all environment variables for Nodes in all Tiers in all Applications in all Controllers covered by this report.

Structure is identical to 6.Node Startup Options

6.Node Env Variables.Type

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

Structure is identical to 6.Node Startup Options.Type

6.Node Env Variables.Location

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

Structure is identical to 6.Node Startup Options.Location

7.Backends

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

Column	Data Type	Purpose
Controller	URL	Controller that was queried
ApplicationName	String	Name of Application
BackendName	String	Name of Backend
BackendType	String	Type of Backend
NumProps	Integer	Number of properties in Backend
Prop#Name (1-7)	String	Name of the N’th property
Prop#Value (1-7)	String	Value of the N’th property
DBMonCollectorName	String	Name of the Database Monitoring Collector that is mapped to this Backend
DBMonCollectorType	String	Type of the Database Monitoring Collector that is mapped to this Backend
ApplicationID	Integer	ID of Application in Controller
BackendID	Integer	ID of Backend in Application
DBMonCollectorConfigID	Integer	ID of Database Monitoring Collector that is mapped to this Backend
DetailLink	Hyperlink	Link to the Entity Details report
MetricGraphLink	HyperLink	Link to the Entity Metric Graphs report
ControllerLink	URL	Link to Controller
ApplicationLink	URL	Link to Application in Controller
BackendLink	URL	Link to Backend in Controller

7.Backends.Type

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

Default configuration provides breakdown of Backends by Type in all Controllers, Applications and Tiers.

Columns	Rows	Values	Filters
BackendType
	Controller
	ApplicationName
	BackendName
		BackendName (Count)

Example report showing fairly complex application with a lot of various Backends registered:

Full Size

Further drill-down shows Custom backends. Notice how one of the exits is defined by Custom Correlation setting, great place to start investigating:

Full Size

7.Backends.Location

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

Default configuration provides breakdown of Backends by location in all Controllers, Applications and Tiers. This is useful when finding Backends with same name registered in multiple places.

Columns	Rows	Values	Filters
	BackendType
	BackendName
	Controller
	ApplicationName
		BackendName (Count)

An example of Backend registered in multiple Applications:

Full Size

8.BTs

This sheet provides information about all Business Transactions in all Tiers in all Applications in all Controllers covered by this report.

Column	Data Type	Purpose
Controller	URL	Controller that was queried
ApplicationName	String	Name of Application
TierName	String	Name of Tier
BTName	String	Name of Business Transaction
BTType	String	Type of Business Transaction
ApplicationID	Integer	ID of Application in Controller
TierID	Integer	ID of Tier in Application
BTID	Integer	ID of Business Transaction in Application
DetailLink	Hyperlink	Link to the Entity Details report
MetricGraphLink	HyperLink	Link to the Entity Metric Graphs report
FlameGraphLink	Hyperlink	Link to the Flame Graph report
FlameChartLink	Hyperlink	Link to the Flame Chart report
ControllerLink	URL	Link to Controller
ApplicationLink	URL	Link to Application in Controller
TierLink	URL	Link to Tier in Controller
BTLink	URL	Link to Business Transaction in Controller

8.BTs.Type

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

Default configuration provides breakdown of Business Transactions by Type in all Controllers, Applications and Tiers.

Columns	Rows	Values	Filters
BTType
	Controller
	ApplicationName
	TierName
	BTName
		BTName (Count)

Example report of fairly complex Application with lots of Business Transactions of various types, including BT Overflow:

Full Size

Drilling down deeper into POJO Business Transactions, we can see what they are:

Full Size

8.BTs.Location

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

Default configuration provides breakdown of Business Transactions by location in all Controllers, Applications and Tiers. This is useful when finding Business Transactions with same name registered in multiple places.

Columns	Rows	Values	Filters
	BTType
	BTName
	Controller
	ApplicationName
	TierName
		BTName (Count)

Example report showing custom POJO registered in multiple Application in two Controllers:

Full Size

9.SEPs

This sheet provides information about all Service Endpoints in all Tiers in all Applications in all Controllers covered by this report.

Column	Data Type	Purpose
Controller	URL	Controller that was queried
ApplicationName	String	Name of Application
TierName	String	Name of Tier
SEPName	String	Name of Service Endpoint
SEPType	String	Type of Service Endpoint
ApplicationID	Integer	ID of Application in Controller
TierID	Integer	ID of Tier in Application
SEPID	Integer	ID of Service Endpoint in Application
DetailLink	Hyperlink	Link to the Entity Details report
MetricGraphLink	HyperLink	Link to the Entity Metric Graphs report
ControllerLink	URL	Link to Controller
ApplicationLink	URL	Link to Application in Controller
TierLink	URL	Link to Tier in Controller
SEPLink	URL	Link to Service Endpoint in Controller

9.SEPs.Type

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

Default configuration provides breakdown of Service Endpoints by Type in all Controllers, Applications and Tiers.

Columns	Rows	Values	Filters
SEPType
	Controller
	ApplicationName
	TierName
	SEPName
		SEPName (Count)

Example report of Application with a LOT of Service Endpoints:

Full Size

9.SEPs.Location

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

Default configuration provides breakdown of Business Transactions by location in all Controllers, Applications and Tiers. This is useful when finding Service Endpoints with same name registered in multiple places.

Columns	Rows	Values	Filters
	SEPType
	SEPName
	Controller
	ApplicationName
	TierName
		SEPName (Count)

Here is an example of Servlet Service Endpoint that should probably be ignored, shown in multiple Applications in multiple Controllers:

Full Size

10.Errors

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

Column	Data Type	Purpose
Controller	URL	Controller that was queried
ApplicationName	String	Name of Application
TierName	String	Name of Tier
ErrorName	String	Name of Error, raw
ErrorType	String	Type of error (Error, Exception, HTTP)
HttpCode	Integer	HTTP Error Code, if ErrorType=HTTP
ErrorDepth	Integer	Depth of wrapped Exception, if ErrorType=Exception
ErrorLevel# (1-5)	String	N’th portion of the Exception, if it was nested
ApplicationID	Integer	ID of Application in Controller
TierID	Integer	ID of Tier in Application
ErrorID	Integer	ID of Error in Application
DetailLink	Hyperlink	Link to the Entity Details report
MetricGraphLink	HyperLink	Link to the Entity Metric Graphs report
ControllerLink	URL	Link to Controller
ApplicationLink	URL	Link to Application in Controller
TierLink	URL	Link to Tier in Controller
ErrorLink	URL	Link to Error in Controller

10.Errors.Type

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

Default configuration provides breakdown of Errors by Type in all Controllers, Applications and Tiers.

Columns	Rows	Values	Filters
ErrorType
	Controller
	ApplicationName
	TierName
	ErrorName
		ErrorName (Count)

Example report showing Application with many types of Errors:

Full Size

10.Errors.Location

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

Default configuration provides breakdown of Business Transactions by location in all Controllers, Applications and Tiers. This is useful when finding Errors with same name registered in multiple places.

Columns	Rows	Values	Filters
	ErrorType
	ErrorName
	Controller
	ApplicationName
	TierName
		ErrorName (Count)

Example report showing interestingly unique Exception showing up across multiple Applications in multiple Controllers:

Full Size

11. Information Points

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

Column	Data Type	Purpose
Controller	URL	Controller that was queried
ApplicationName	String	Name of Application
IPName	String	Name of Information Point
IPType	String	Type of Information Point (Java, .NET)
ApplicationID	Integer	ID of Application in Controller
IPID	Integer	ID of Information Point in Application
DetailLink	Hyperlink	Link to the Entity Details report
MetricGraphLink	HyperLink	Link to the Entity Metric Graphs report
ControllerLink	URL	Link to Controller
ApplicationLink	URL	Link to Application in Controller
IPLink	URL	Link to Information Point in Controller

11.Information Points.Type

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

Default configuration provides breakdown of Errors by Type in all Controllers, Applications and Tiers.

Columns	Rows	Values	Filters
IPType
	Controller
	ApplicationName
	IPName
		IPName (Count)

Example report showing Application with some Information Points: Full Size