Skip to content

Dashboards Report

Daniel Odievich edited this page Mar 25, 2019 · 12 revisions

Overview

Dashboards report shows information about Dashboard, their Widgets and Time Series referenced by then in Controller

Detected APM Entities report is produced when:

Report File Locations

Dashboards report has the following file name:

Report\Dashboards.<Job File Name>.<Start Date and Time>-<End Date and Time>.xlsx

For example:

Dashboards.demo2Ecommerce.2017091914-2017091916.xlsx

Data File Locations

The data for the report is in the following files:

  • Report\DASH\dashboards
  • Report\DASH\dashboard.widgets.csv
  • Report\DASH\dashboard.dataseries.csv

Report Contents

Data Pivot
1.Parameters
2.Contents
3.Controllers
4.Applications.All
5.Dashboards 5.Dashboards.Type
6.Widgets 6.Widgets.Type
7.Data Series 7.Data Series.Type, 7.Data Series.Location

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
ApplicationType String Type of the Application

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
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

5.Dashboards

This sheet provides information about all Dashboards all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
DashboardName String Name of Application
Description String Description of Application
NumWidgets Integer Number of Widgets on Dashboard
NumAnalyticsWidgets Integer Number of Analytics Widgets on Dashboard
NumEventListWidgets Integer Number of Event List Widgets on Dashboard
NumGaugeWidgets Integer Number of Gauge Widgets on Dashboard
NumGraphWidgets Integer Number of Graph Widgets on Dashboard
NumHealthListWidgets Integer Number of Health Rule Widgets on Dashboard
NumIFrameWidgets Integer Number of IFrame Widgets on Dashboard
NumImageWidgets Integer Number of Image Widgets on Dashboard
NumMetricLabelWidgets Integer Number of Metric Label Widgets on Dashboard
NumPieWidgets Integer Number of Pie Widgets on Dashboard
NumTextWidgets Integer Number of Text Label Widgets on Dashboard
CanvasType String Type of Canvas (ABSOLUTE, GRID)
TemplateEntityType String Not sure what this is
SecurityToken String If Dashboard is shared, the Security Token
IsShared Boolean Is Dashboard shared
IsSharingRevoked Boolean Is Dashboard sharing revoked
IsTemplate Boolean Not sure what this is
Width Integer Dashboard width
Height Integer Dashboard height
BackgroundColor String Background Color (RGB)
MinutesBefore Integer TODO
RefreshInterval Integer TODO
StartTime String Start time of Dashboard display range, local time
StartTimeUtc String Start time of Dashboard display range, UTC time
EndTime String End time of Dashboard display range, local time
EndTimeUtc String End time of Dashboard display range, UTC time
CreatedBy String Who created this Dashboard
CreatedOn DateTime When the Dashboard was created, local time
CreatedOnUtc DateTime When the Dashboard was created, UTC time
UpdatedBy String Who updated this Dashboard last
UpdatedOn DateTime When the Dashboard was updated, local time
UpdatedOnUtc DateTime When the Dashboard was updated, UTC time
DashboardID Integer ID of Dashboard in Controller
DashboardLink String Link to Dashboard in Controller

5.Dashboards.Type

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

Default configuration provides breakdown of Dashboard and their Widgets in all Controllers.

Columns Rows Values Filters
Controller
CanvasType
DashboardName
DashboardID (Count)
NumWidgets (Sum)
NumAnalyticsWidgets (Sum)
NumEventListWidgets (Sum)
NumGaugeWidgets (Sum)
NumGraphWidgets (Sum)
NumIFrameWidgets (Sum)
NumImageWidgets (Sum)
NumMetricLabelWidgets (Sum)
NumPieWidgets (Sum)
NumTextWidgets (Sum)
CreatedBy
UpdatedBy
IsShared

Example report showing Controller with many types of Dashboards:

Full Size

TODO 12.Errors.Location

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:

Full Size

Clone this wiki locally