Skip to content

Licenses Report

Jump to bottom
Daniel Odievich edited this page May 8, 2020 · 19 revisions

Overview

Licenses report provides information about global account and license rule configuration and consumption for Controller.

Licenses report is produced when:

Example Job File.

Report File Locations

Licenses report has the following file name:

Report\Licenses.<Job File Name>.<Start Date and Time in yyyyMMddHHmm>.<Number Of Hours Spanned By Report>.xlsx

For example:

Licenses.demo2Ecommerce.2017091914.2.xlsx

Data File Locations

The data for the report is in the following files:

  • Report\LIC\account.csv
  • Report\LIC\licenserules.csv
  • Report\LIC\licenserulescopes.csv
  • Report\LIC\licenses.csv
  • Report\LIC\licenseusage.account.csv
  • Report\LIC\licenseusage.rules.csv

Data Schema

Full Size

Report Contents

Data Pivot
1.Parameters
2.Contents
3.Controllers
4.Applications.All
5.Accounts
6.Licenses 6.Licenses.Type
7.Licenses Usage 7.Licenses Usage.Timeline
8.License Rules 8.License Rules.Type
9.License Rules Usage 9.License Rules Usage.Timeline
10.License Rule Scopes 10.License Rule Scopes.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
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 APM 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

4.Applications.All

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

5.Accounts

This sheet lists all Accounts settings in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
AccountName String Name of Account, short version
AccountNameGlobal String Name of Account, long version
AccountNameEUM String Name of Account, EUM version
AccessKey1 String Access key for Account, short version
AccessKey2 String Access key for Account, long version
LicenseKeyEUM String License key for EUM
ServiceKeyES String Events service key
ExpirationDate DateTime Account expiration date
AccountID Integer ID of the Account
LicenseLink URL Link to Controller License page for this time range

6.Licenses

This sheet lists all global Licenses in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
AccountName String Name of Account, short version
AgentType String Type of licensed Agent
Edition String License edition
Model String License model
Provisioned Integer Number of Licenses associated with this agent
MaximumAllowed Integer Number of Licenses associated with this agent, maximum
Average Integer Units of consumption associated with this License in this time range
Min Integer Minimum License consumption for this License in this time range
Max Integer Maximum License consumption for this License in this time range
Retention Integer Retention period, days
ExpirationDate DateTime License expiration date, UTC
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
AccountID Integer ID of the Account

6.Licenses.Type

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

Default configuration provides breakdown of Licenses by type in the Controller.

Columns Rows Values Filters
AgentType
Controller
Average (Sum)
Edition
Model

Example report showing a 3 Controller license settings:

Full Size

7.Licenses Usage

This sheet lists usage for Global Licenses in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
AccountName String Name of Account, short version
RuleName String Name of the Rule. Always "Account" in this case
AgentType String Type of licensed Agent
LicenseEventTime DateTime When was license consumed, local time
LicenseEventTimeUtc DateTime When was license consumed, UTC time
Average Integer Average value of consumption
Min Integer Min value of consumption in time period
Max Integer Max value of consumption in time period
Total Integer Total value of consumption in time period
Samples Integer Number of 5 minute samples in the time range
AccountID Integer ID of the Account

7.Licenses Usage.Timeline

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

Default configuration provides per-hour summary of License consumption by Agent Type.

Columns Rows Values Filters
Controller
AgentType
LicenseEventTime
Average (Average)

In this example, we are showing license consumption of .NET, Java and Node.JS licenses over 2 days in single Controller:

Full Size

8.License Rules

This sheet lists all Licenses Rules in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
AccountName String Name of Account, short version
RuleName String Name of the Rule
AgentType String Type of licensed Agent
RuleLicenses Integer Number of Licenses in this entire Rule
RulePeak Integer Maximum License consumption for this License Rule in this time range
Licenses Integer Number of Licenses associated with this agent in this Rule
NumApplications Integer Number of Application entities associated with this Rule
NumServers Integer Number of Machine entities associated with this Rule
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
AccessKey String Access key used by the account
AccountID Integer ID of the Account
RuleID String ID of the Rule

8.License Rules.Type

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

Default configuration provides breakdown of License Rules by number of assigned Applications by type in the Controller.

Columns Rows Values Filters
AgentType
Controller
NumApplications
RuleName
Licenses (Sum)

Example report showing a License Rules per agent settings:

Full Size

9.License Rules Usage

This sheet lists usage for License Rules in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
AccountName String Name of Account, short version
RuleName String Name of the Rule
AgentType String Type of licensed Agent
LicenseEventTime DateTime When was license consumed, local time
LicenseEventTimeUtc DateTime When was license consumed, UTC time
Average Integer Units of consumption associated with this License in this time range
AccountID Integer ID of the Account

9.License Rules Usage.Timeline

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

Default configuration provides per-hour summary of License consumption in License Rule by Agent Type.

Columns Rows Values Filters
Controller
RuleName
AgentType
LicenseEventTime
Average (Average)

In this example, we are showing license consumption of all licenses for single rule over 2 days in single Controller:

Full Size

10.License Rule Scopes

This sheet lists selected Entities for all Licenses Rules in all Controllers covered by this report.

Column Data Type Purpose
Controller URL Controller that was queried
AccountName String Name of Account, short version
RuleName String Name of the Rule
ScopeSelector String How is Entity Selected
MatchType String How is Entity matched
EntityName String Name of matched Entity
EntityType String Type of matched Entity
EntityID Integer ID of matched Entity
AccountID Integer ID of the Account
RuleID String ID of the Rule

10.License Rule Scopes.Type

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

Default configuration provides information about entities (Applications, Machines) assigned via rules to the License Rules.

Columns Rows Values Filters
EntityType
Controller
RuleName
MatchType
EntityName
RuleID (Count)

Example report showing the assignments for single rule:

Full Size

Clone this wiki locally