Generating usage report logs
Go Up to Administering the Embarcadero License Center
The Reporting Logs feature for ELC version 4 is provided to customers to log and export license usage data from ELC. Tracked usage data consists of the following:
- User/Permission Data
- Product Data
- Licenses (duration of use, initial start times, finish times, license types)
This data can be exported from ELC to three different formats:
- JDataStore (JDS) database file
- XML with corresponding xml schema documents (XSD) file
- Comma-separated value (CSV) file with corresponding schema files
Contents
To enable or disable ELC reporting logs
- Edit the
elise.properties
file in the<ELC>/conf
directory. - To enable logging, set
reportLogsEnabled
totrue
(by default this property is set totrue
). - To disable report logging, set
reportLogsEnabled
tofalse
.
To export ELC reporting logs
Export ELC reporting logs using the ELC command-line interface.
Running the exportlogs command with options
The exportLogs
command has the following form:
elise cmd exportLogs ( -dir <directory> ) ( -csv | -xml | -db ) ( -purge )
The exportLogs
command has the following options:
-csv -- generates a set of comma-separated value list files and schema files containing data representative of every table in the database. Files exported using the -csv option are as follows:
lm_denial_entry.csv
lm_denial_entry.schema
lm_entry_instance.csv
lm_entry_instance.schema
lm_ip_block.csv
lm_ip_block.schema
lm_license.csv
lm_license.schema
lm_license_pool.csv
lm_license_pool.schema
lm_permission.csv
lm_permission.schema
lm_pool_entry.csv
lm_pool_entry.schema
lm_pool_type_lu.csv
lm_pool_type_lu.schema
lm_product.csv
lm_product.schema
lm_timestamp.csv
lm_timestamp.schema
lm_user.csv
lm_user.schema
- -xml-- generates an xml file of the database along with an xsd file. Files exported using the -xml option:
export.xml
lm_reporting.xsd
lm_reporting_access.xsd
– additional xsd file with Microsoft-specific attributes for importing data into Microsoft Access
- -db-- generates a set of JDataStore database files that can be opened using the JDataStore Explorer. Files exported with the -db option include the following:
LM_REPORTING.jds
LM_REPORTING_LOGA_0000000000
LM_REPORTING_STATUS_0000000000
LM_REPORTING_LOGA_ANCHOR
- -purge -- enables users to remove/clear all records from the database with the exception of license records that are still actively in use. As a safety mechanism, using the -purge option without any other logging options, as shown below, forces a report logging export using all formats (csv, xml, db) before any data is purged.
>elise cmd exportLogs –purge
The following data shows the growth of the reporting database with respect to the total number of records in the database after 6 man months for various usage rates:
Use rate (Users / man day) | Total records added after 6 man months | Database size after 6 man months (KB) | Database Transaction log size after 6 man months (KB) |
---|---|---|---|
10 |
2650 |
2067 |
6952 |
25 |
6625 |
4849 |
14504 |
50 |
13250 |
9487 |
27092 |
100 |
26500 |
18762 |
52267 |
500 |
132500 |
92962 |
253667 |
- -dir -- used to specify an output directory for exporting logging data to. If no export directory is specified, logging data will be written to
$ELC_HOME$/export
directory.
Running the exportlogs command without options
Running the exportLogs command with no options exports reporting data to all formats as shown below:
>elise cmd exportLogs
Running the exportremotelogs command to export logs from a remote database
The exportRemoteLogs command is used to export older version ELC or BLS databases to an ELC version 4.12 reporting log. This newer format reporting log can be imported into ReportingEngine 2.1 at any time for reporting purposes. The following parameters can be specified when using the remoteExport command:
> elise cmd exportRemoteLogs -from <OLD_ELC_BLS_HOME> [-to <export_dir>]
- -
from
- This is a required parameter which should point to the older ELC or BLS server's home directory. - -
to
- An optional parameter which specifies the directory where the exported ELC v4.12 reporting log should be exported to. If no -to parameter is specified then a directory named "remote-export" is created under ELC_HOME and export logs are stored there.
Example:
elise cmd exportRemoteLogs -from C:\Embarcadero\LicenseCenter4.03
ELC reporting logs timeout functionality
The ELC Reporting Logs export feature has been built with internal timeout functionality to prevent export from occurring during periods of high load. This is designed to prevent interruption to the mission-critical purpose of ELC, which is serving licenses to Embarcadero Concurrent and Networked Named User customers.
To troubleshoot reporting logs
In order to troubleshoot the ELC Reporting Logs functionality, please add the following to the elise.properties
file and restart ELC:
debugReportLogs = true
If errors appear in the db.log
file (located in the $ELC_HOME\logs
directory), please send the following to Embarcadero Customer Support:
- db.log file
- JDK version you are using
- OS you are running ELC on
- A description of the error(s) you are seeing