Detected APM Entities Report
Detected APM Entities report shows information about each and every detected Entity in APM applications including Applications, Tiers, Nodes, Business Transactions, Backends, Mapped Backends, Service Endpoints, Errors and Information Points.
Detected APM Entities report is produced when Output.DetectedEntities=True. It uses detected metadata data that is always extracted.
Detected APM Entities report has the following file name Report\DetectedEntities.<Job File Name>.<Start Date and Time>-<End Date and Time>.xlsx
For example, DetectedEntities.demo2Ecommerce.2017091914-2017091916.xlsx
The data for the report is in the following files:
- Report\ENT\applications.csv
- Report\ENT\controllers.csv
- Report\ENTAPM\applications.apm.csv
- Report\ENTAPM\backends.csv
- Report\ENTAPM\businesstransactions.csv
- Report\ENTAPM\errors.csv
- Report\ENTAPM\informationpoints.csv
- Report\ENTAPM\mappedbackends.csv
- Report\ENTAPM\nodes.csv
- Report\ENTAPM\serviceendpoints.csv
- Report\ENTAPM\tiers.csv
If Controller is 4.4 or later:
- Report\ENTAPM\nodeenvironmentvariables.csv
- Report\ENTAPM\nodeproperties.csv
- Report\ENTAPM\nodestartupoptions.csv
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 |
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 |
This sheet provides information about Controllers covered by this report.
| Column | Data Type | Purpose |
|---|---|---|
| Controller | URL | Controller that was queried |
| Version | String | Version of the Controller |
| VersionDetail | String | Full version string of the Controller |
| NumApps | Integer | Number of All Applications registered in the Controller |
| NumAPMApps | Integer | Number of APM Applications registered in the Controller |
| NumWEBApps | Integer | Number of WEB Applications registered in the Controller |
| NumMOBILEApps | Integer | Number of MOBILE Applications registered in the Controller |
| NumIOTApps | Integer | Number of IoT Applications registered in the Controller |
| NumSIMApps | Integer | Number of SIM Applications registered in the Controller |
| NumBIQApps | Integer | Number of BIQ Applications registered in the Controller |
| NumDBApps | Integer | Number of DB Applications registered in the Controller |
| ControllerLink | URL | Link to Controller |
This sheet lists all Applications of any Type 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 |
| Type | String | Type of the Application |
| Types | Array | Types of Application in this application. Most commonly seen are APM and WEB grouped together |
| CreatedBy | String | Who created this Application |
| CreatedOn | DateTime | When the Application was created, local time |
| CreatedOnUtc | DateTime | When the Application was created, UTC time |
| UpdatedBy | String | Who updated this Application last |
| UpdatedOn | DateTime | When the Application was updated, local time |
| UpdatedOnUtc | DateTime | When the Application was updated, UTC time |
| ApplicationID | Integer | ID of Application in Controller |
| ParentApplicationID | Integer | ID of Parent Application. Used by MOBILE Applications |
This sheet provides information about all APM 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 |
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 |
This sheet uses data in 6.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:
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 |
This sheet uses data in 7.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:
This sheet uses data in 7.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 | |||
| MachineName (Count) | |||
| MachineAgentPresent |
Example report showing Application with Machine Agents of various ages:
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 |
This sheet uses data in 8.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":
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:
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 8.Node Startup Options
This sheet uses data in 8.Node VM Properties sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.
Structure is identical to 8.Node Startup Options.Type
This sheet uses data in 8.Node VM Properties sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.
Structure is identical to 8.Node Startup Options.Location
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 8.Node Startup Options
This sheet uses data in 8.Node Env Variables sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.
Structure is identical to 8.Node Startup Options.Type
This sheet uses data in 8.Node Env Variables sheet as source for pivot table to enable summary reporting and ad-hoc drill-down.
Structure is identical to 8.Node Startup Options.Location
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 |
This sheet uses data in 9.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:
Further drill-down shows Custom backends. Notice how one of the exits is defined by Custom Correlation setting, great place to start investigating:
This sheet uses data in 9.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:
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 |
| BTNameOriginal | String | OriginalName of Business Transaction before it was renamed |
| IsRenamed | Boolean | Whether Business Transaction was renamed |
| 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 |
This sheet uses data in 10.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) | |||
| IsRenamed |
Example report of fairly complex Application with lots of Business Transactions of various types, including BT Overflow:
Drilling down deeper into POJO Business Transactions, we can see what they are:
This sheet uses data in 10.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) | |||
| IsRenamed |
Example report showing custom POJO registered in multiple Application in two Controllers:
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 |
This sheet uses data in 11.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:
This sheet uses data in 11.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:
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 |
This sheet uses data in 12.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) | |||
| ErrorDepth |
Example report showing Application with many types of Errors:
This sheet uses data in 12.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) | |||
| ErrorDepth |
Example report showing interestingly unique Exception showing up across multiple Applications in multiple Controllers:
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 |
This sheet uses data in 13.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
This sheet provides information about all Backends mapped/resolved to 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 |
| 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 |
| CreatedOn | DateTime | When the Backend was resolved to Tier, local time |
| CreatedOnUtc | DateTime | When the Backend was resolved to Tier, UTC time |
| ApplicationID | Integer | ID of Application in Controller |
| TierID | Integer | ID of Tier in Application |
| TierID | Integer | ID of Tier in Application |
| NodeID | Integer | ID of APM Agent in Application |
| BackendID | Integer | ID of Backend in Application |
This sheet uses data in 14.Mapped 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 | |||
| TierName | |||
| BackendName | |||
| BackendID (Count) |
Example report showing ECommerce application with what Backends were resolved to specific Tier:
Full Size
