#
Tasking License Management System (TLM)
#
Introduction
Open iT supports TLM usage reporting. The following sections will guide you on the required configuration for
Apply the configurations in the Open iT client.
#
Configuring License Manager Utility Polling
Open iT supports Tasking License Management System (TLM) usage reporting through the generic license type format. This will produce the following aggregated data types used for historical and real-time reporting:
- (49) Host User License Use
- (93) OLAP Raw Hourly
- (94) OLAP User Concurrency
- (95) Usergroup License Use v3.0
- (102) OLAP Total Use
The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.
#
Requirements
- Configured TLM License Server
- Valid URL with the port number of the TLM API
- An Open iT Client connected to an Open iT Server or a coexistent Open iT setup
- Activated LicenseAnalyzer collection and license poller
#
Configuring Data Collection
These are the required steps to activate and configure collection of TLM usage data.
Go to the Components directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration\Components
, and back up thelicpoll.xml
configuration file.Open a command prompt with Administrator level privileges.
Go to the bin directory, which is by default in
C:\Program Files\OpeniT\Core\bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd C:\Program Files\OpeniT\Core\bin
Once in the directory, copy the object node
genericlicense-sample
, run the command:Command Syntaxopenit_confinit -c "licpoll.license-types.genericlicense-sample=>licpoll.license-types.tlm"
Activate the collection of TLM data, run the command:
Command Syntaxopenit_confinit -c "licpoll.license-types.tlm.active=true"
Set the arguments to the status command, run the command:
Command Syntaxopenit_confinit -c "licpoll.license-types.tlm.status-command.arguments=TLM <api_url>"
where
<api_url>
is the corresponding valid URL with the port number of the TLM API.Exampleopenit_confinit -c "licpoll.license-types.tlm.status-command.arguments=TLM http://localhost:9090"
Update the configuration file, run the command:
Command Syntaxopenit_confbuilder --client
Make sure that there are no errors encountered.
Refer to the TLM Data Collection Configuration table to learn more about TLM configuration in licpoll.xml
.
#
Verifying Data Collection
After configuration, you can verify that the data is collected by following these steps:
Open a command prompt with Administrator level privileges.
Go to the bin directory, which is by default in
C:\Program Files\OpeniT\Core\bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd C:\Program Files\OpeniT\Core\bin
Run the command:
Command Syntaxopenit_licpoll -# 1
Verify that the temp directory, which is by default in
C:\ProgramData\OpeniT\Data\temp
, contains aLicPoll
directory containing.data
andstatus-*.log
files.
#
Configuring Log File Parsing
Open iT collects log files and converts them to Open iT format. This will produce the following aggregated data types used for historical and real-time reporting:
The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.
#
Requirements
- An Open iT Client connected to an Open iT Server or a coexistent Open iT setup
- License server administrative rights
- Full path to the debug log file
#
Configuring Log File Collection
These are the required steps to configure collection of TLM log files.
Go to the Components directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration\Components
, and openlogfilecollector-tlm.xml
.Locate object node
dir
and set its value to the location of the TLM log files.logfilecollector-tlm.xml14| <Object> 15| <Name>dir</Name> 16| <Description>Directory containing the log files</Description> 17| <Value type="DirName">%TLMLOGDIR%</Value> 18| </Object>
Example: logfilecollector-tlm.xml14| <Object> 15| <Name>dir</Name> 16| <Description>Directory containing the log files</Description> 17| <Value type="DirName">C:\tlm\logs</Value> 18| </Object>
Save the changes.
Open a command prompt with Administrator level privileges.
Go to the bin directory, which is by default in
C:\Program Files\OpeniT\Core\bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd C:\Program Files\OpeniT\Core\bin
Update the configuration file, run the command:
Command Syntaxopenit_confbuilder --client
Make sure that there are no errors encountered.
Refer to the TLM Log File Collection Configuration table to learn more about TLM configuration in logfilecollector-tlm.xml
.
Go to the Components directory, which is by default in
/var/opt/openit/etc/Components
, and openlogfilecollector-tlm.xml
.Locate object node
dir
and set its value to the location of the TLM log files.logfilecollector-tlm.xml14| <Object> 15| <Name>dir</Name> 16| <Description>Directory containing the log files</Description> 17| <Value type="DirName">%TLMLOGDIR%</Value> 18| </Object>
Example: logfilecollector-tlm.xml14| <Object> 15| <Name>dir</Name> 16| <Description>Directory containing the log files</Description> 17| <Value type="DirName">/tlm/logs</Value> 18| </Object>
Save the changes.
Go to the bin directory, which is by default in
/opt/openit/bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd /opt/openit/bin
Update the configuration file, run the command:
Command Syntax./openit_confbuilder --client
Make sure that there are no errors encountered.
Refer to the TLM Log File Collection Configuration table to learn more about TLM configuration in logfilecollector-tlm.xml
.
#
Activating Log Data Collection
These are the required steps to activate collection of TLM log data.
Go to the scheduler directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration\scheduler
, and opencollect_license_tlm-logs.oconf
.Locate and set
root.scheduler.jobs.collect_tlm_licenselogs.general.active
to true to activate the collection of TLM log data.collect_license_tlm-logs.oconf13| } 14| general 15| { 16| active 17| { 18| type=bool 19| value=true
Save the changes.
The collection runs hourly using a 5-minute sample interval by default. The primary data is then transferred to the server every night according to the client timezone for processing. To configure the intervals, locate the instances
attribute under collect_tlm_licenselogs
, preprocess_tlm_licenselogs-events
, preprocess_tlm_licenselogs-records
, or transfer_tlm_licenselogs
in the same file and configure the attributes.
Refer to the TLM Log Job Scheduler Instances Configuration table to learn the attributes used to configure TLM data collection and transfer.
Go to the scheduler directory, which is by default in
/var/opt/openit/etc/scheduler
, and opencollect_license_tlm-logs.oconf
.Locate and set
root.scheduler.jobs.collect_tlm_licenselogs.general.active
to true to activate the collection of TLM log data.collect_license_tlm-logs.oconf13| } 14| general 15| { 16| active 17| { 18| type=bool 19| value=true
Save the changes.
The collection runs hourly using a 5-minute sample interval by default. The primary data is then transferred to the server every night according to the client timezone for processing. To configure the intervals, locate the instances
attribute under collect_tlm_licenselogs
, preprocess_tlm_licenselogs-events
, preprocess_tlm_licenselogs-records
, or transfer_tlm_licenselogs
in the same file and configure the attributes.
Refer to the TLM Log Job Scheduler Instances Configuration table to learn the attributes used to configure TLM data collection and transfer.
#
Verifying Log Data Collection
After configuration, you can verify that the data is collected and sent to the server by following these steps:
Open a command prompt with Administrator level privileges.
Go to the bin directory, which is by default in
C:\Program Files\OpeniT\Core\bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd C:\Program Files\OpeniT\Core\bin
Run the command:
Command Syntaxopenit_executor -r collect_license_tlm-logs
Verify that there are
archiver*.in
files created in the server in the archiver directory, which is by default inC:\ProgramData\OpeniT\Data\incoming\archiver
.
Go to the bin directory, which is by default in
/opt/openit/bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd /opt/openit/bin
Run the command:
Command Syntax./openit_executor -r collect_license_tlm-logs
Verify that there are
archiver*.in
files created in the incoming directory in your defined data_dir($ROOT_DATA_DIR)
upon Open iT server installation.
#
Next Steps?
Renaming Vendor License Renaming Features Create and Add Report License Monitor