# Tebis License Manager

# Introduction

Open iT supports Tebis usage reporting by collecting log files and converting them to Open iT format.

An Open iT client is installed on your license server for this collection. The data collector monitors and gathers the license usage history logs from the license manager every midnight. Once the logs are collected, the data collection process triggers and the logs are passed to the data preprocessor. After the data is preprocessed, it is transferred to the Core Server for further storage, completing the history logs collection and processing.

Log File Parsing Workflow

Log File Parsing Workflow

This will produce the following aggregated data types used for historical reporting:

Record Log Data:

Event Log Data:

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 Tebis log files.

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and open logfilecollector-tebis.xml.

  2. Locate object node dir and set its value to the location of the Tebis log files.

    logfilecollector-tebis.xml
     14|	<Object>
 15|		<Name>dir</Name>
 16|		<Description>Directory containing the log files</Description>
 17|		<Value type="DirName">%TEBISLOGDIR%</Value>
 18|	</Object>
    Example: logfilecollector-tebis.xml
     14|	<Object>
 15|		<Name>dir</Name>
 16|		<Description>Directory containing the log files</Description>
 17|		<Value type="DirName">C:\ProgramData\Tebis</Value>
 18|	</Object>

  3. Locate object node pattern and change its value if the log file has a different file extension than the default *.log.

    logfilecollector-tebis.xml
     19|	<Object>
 20|		<Name>pattern</Name>
 21|		<Description>Glob identifying log files</Description>
 22|		<Value type="DirName">*.log</Value>
 23|	</Object>
    Example: logfilecollector-tebis.xml
     19|	<Object>
 20|		<Name>pattern</Name>
 21|		<Description>Glob identifying log files</Description>
 22|		<Value type="DirName">*.dbg</Value>
 23|	</Object>

  4. Save the changes.

  5. Open a command prompt with Administrator level privileges.

  6. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd C:\Program Files\OpeniT\Core\bin

  7. Update the configuration file, run the command:

    Command Syntax
     openit_confbuilder --client

    Make sure no errors are encountered.

Refer to the Tebis Log File Collection Configuration table to learn more about Tebis configuration in logfilecollector-tebis.xml.

Object Name Accepted Value Description
source.dir DirName (e.g., C:\ProgramData\Tebis) Location of the Tebis log files.
source.pattern String (*.log, *.txt, or *.dbg) The glob pattern identifying source files in the source directory.
source.seen String (collect, ignore, or tail) Seen files are the previously collected source files.
  • collect - Specify this option to collect from the start each time.
  • ignore - Specify this option to skip collecting from the same file again.
  • tail - Specify this option to continue collection from the end of the file last time (i.e., collect the ones added since last time).
source.cmplines Integer (e.g., 6, 10, 20) This is required if the value of source.seen is tail. This is the number of lines compared to source files collected before to determine where to start the collection.

Note: If this number is too low, you can end up with an incorrect position, and duplicate data may be in the log files. Usually, it is better to have a few lines more than strictly necessary than even a single line too little.
target.dir DirName (i,e., ${OpeniT.directories.temp}/LogFileCollector) This is the location of the directory containing the collected log data.
target.module String (i.e., license) The target type of module (in general).
target.datatype String (i.e., tebis) The specific type of target data.
target.interval Timespan (e.g., P30S, P5M, P1D) The span of time between collector runs.
target.rotation-size Integer (e.g., 6, 10, 20) The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-glob String (e.g., *) The glob pattern to match before the log file rotates.
Tebis Log File Collection Configuration

  1. Go to the Components directory, which is by default in /var/opt/openit/etc/Components, and open logfilecollector-tebis.xml.

  2. Locate object node dir and set its value to the location of the Tebis log files.

    logfilecollector-tebis.xml
     14|	<Object>
 15|		<Name>dir</Name>
 16|		<Description>Directory containing the log files</Description>
 17|		<Value type="DirName">%TEBISLOGDIR%</Value>
 18|	</Object>
    Example: logfilecollector-tebis.xml
     14|	<Object>
 15|		<Name>dir</Name>
 16|		<Description>Directory containing the log files</Description>
 17|		<Value type="DirName">/var/opt/tebis</Value>
 18|	</Object>

  3. Locate object node pattern and change its value if the log file has a different file extension than the default *.log.

    logfilecollector-tebis.xml
     19|	<Object>
 20|		<Name>pattern</Name>
 21|		<Description>Glob identifying log files</Description>
 22|		<Value type="DirName">*.log</Value>
 23|	</Object>
    Example: logfilecollector-tebis.xml
     19|	<Object>
 20|		<Name>pattern</Name>
 21|		<Description>Glob identifying log files</Description>
 22|		<Value type="DirName">*.dbg</Value>
 23|	</Object>

  4. Save the changes.

  5. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  6. Update the configuration file, run the command:

    Command Syntax
     ./openit_confbuilder --client

    Make sure no errors are encountered.

Refer to the Tebis Log File Collection Configuration table to learn more about Tebis configuration in logfilecollector-tebis.xml.

Object Name Accepted Value Description
source.dir DirName (e.g., /root/tebis/logs) Location of the Tebis log files.
source.pattern String (*.log, *.txt, or *.dbg) The glob pattern identifying source files in the source directory.
source.seen String (collect, ignore, or tail) Seen files are the previously collected source files.
  • collect - Specify this option to collect from the start each time.
  • ignore - Specify this option to skip collecting from the same file again.
  • tail - Specify this option to continue collection from the end of the file last time (i.e., collect the ones added since last time).
source.cmplines Integer (e.g., 6, 10, 20) This is required if the value of source.seen is tail. This is the number of lines compared to source files collected before to determine where to start the collection.

Note: If this number is too low, you can end up with an incorrect position, and duplicate data may be in the log files. Usually, it is better to have a few lines more than strictly necessary than even a single line too little.
target.dir DirName (i,e., ${OpeniT.directories.temp}/LogFileCollector) This is the location of the directory containing the collected log data.
target.module String (i.e., license) The target type of module (in general).
target.datatype String (i.e., tebis) The specific type of target data.
target.interval Timespan (e.g., P30S, P5M, P1D) The span of time between collector runs.
target.rotation-size Integer (e.g., 6, 10, 20) The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-glob String (e.g., *) The glob pattern to match before the log file rotates.
Tebis Log File Collection Configuration

# Activating Log Data Collection

These are the required steps to activate collection of Tebis log data.

  1. Open a command prompt with Administrator level privileges.

  2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd C:\Program Files\OpeniT\Core\bin

  3. Once in the directory, activate the collection of Tebis log data, run the command:

    Command Syntax
     openit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.collect_tebis_licenselogs.general.active=true"

  1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  2. Once in the directory, activate the collection of Tebis log data, run the command:

    Command Syntax
     ./openit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.collect_tebis_licenselogs.general.active=true"

The collection runs every 5 minutes by default. To configure the intervals, locate the instances attribute under collect_tebis_licenselogs, preprocess_tebis_licenselogs-events, preprocess_tebis_licenselogs-records, or transfer_tebis_licenselogs in the same file and configure the attributes.

Refer to the Tebis Log Job Scheduler Instances Configuration table to learn the attributes used to configure Tebis data collection and transfer.

Attribute Name Accepted Value Description
max-instances Uint (e.g., 5, 8, 9) The number of instances allowed to run at the same time.
max-handling String (end-oldest, end-all-old, or end-new) The action done upon reaching the maximum number of instances. Specify end-oldest to stop/kill the oldest instance and then start the new, specify end-all-old to stop/kill all running instances and then start the new, or specify end-new to not start the new instance.
end-timeout Timespan (e.g., P30S, P5M, P1H) The maximum waiting time before terminating a running instance.
quarantine Timespan (e.g., P30S, P5M, P1H) The waiting time before starting a new instance after a previous one.
Tebis Log Job Scheduler Instances Configuration

# Deactivating Record Log Data Collection

Turning on log data collection automatically aggregates record and event log data. If you want to collect event log data only, follow these steps.

  1. Open a command prompt with Administrator level privileges.

  2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd C:\Program Files\OpeniT\Core\bin

  3. Once in the directory, deactivate the collection of record log data, run the command:

    Command Syntax
     openit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.preprocess_tebis_licenselogs-records.general.active=false"

  4. Change the handling of event logs, run the command:

    Command Syntax
     openit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.preprocess_tebis_licenselogs-events.operations.arguments=--srcdir \"${OpeniT.directories.temp}/LogFileCollector\" --srcpattern raw-tebis-license-LogFileCollector*.data --srcfilehandling rename --trgdir \"${OpeniT.directories.temp}/LogParserTebis\" --module license --datatype event --resolution PT1H --matchobjects \"${OpeniT.directories.conf}/matchobjects-event-tebis.oconf\" --type event --disable-statlogging"

  5. Change the data transfer schedule, run the command:

    Command Syntax
     openit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.transfer_tebis_licenselogs.scheduling.start-triggers.trigger#1.job-name=preprocess_tebis_licenselogs-events"

  1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  2. Once in the directory, deactivate the collection of record log data, run the command:

    Command Syntax
     ./openit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.preprocess_tebis_licenselogs-records.general.active=false"

  3. Change the handling of event logs, run the command:

    Command Syntax
     ./openit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.preprocess_tebis_licenselogs-events.operations.arguments=--srcdir \"${OpeniT.directories.temp}/LogFileCollector\" --srcpattern raw-tebis-license-LogFileCollector*.data --srcfilehandling rename --trgdir \"${OpeniT.directories.temp}/LogParserTebis\" --module license --datatype event --resolution PT1H --matchobjects \"${OpeniT.directories.conf}/matchobjects-event-tebis.oconf\" --type event --disable-statlogging"

  4. Change the data transfer schedule, run the command:

    Command Syntax
     ./openit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.transfer_tebis_licenselogs.scheduling.start-triggers.trigger#1.job-name=preprocess_tebis_licenselogs-events"

# Verifying Log Data Collection

After configuration, you can verify that the data is collected and sent to the server by following these steps:

  1. Open a command prompt with Administrator level privileges.

  2. Go to the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd C:\Program Files\OpeniT\Core\bin

  3. Run the command:

    Command Syntax
     openit_executor -r collect_license_tebis-logs

  4. Verify that there are archiver*.in files created in the server in the archiver directory, which is by default in C:\ProgramData\OpeniT\Data\incoming\archiver.

  1. Go to the bin directory, which is by default in /opt/openit/bin, run the command:

    Command Syntax
     cd $BIN_DIR
    Example
     cd /opt/openit/bin

  2. Run the command:

    Command Syntax
     ./openit_executor -r collect_license_tebis-logs

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

Powered by Open iT ® Open iT Docs All rights reserved.

We value your feedback!

Please take a few minutes to complete our survey and share your thoughts on your recent experience with our documentation.

Take survey

Close