Tebis License Manager
Introduction
Open iT supports Tebis usage reporting by collecting log files and converting them to Open iT format.
An Open iT Core 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.
This will produce the following aggregated data types used for historical reporting:
Record Log Data:
- (89) Total License Use Licenseevents
- (90) Individual License Use Licenseevents
- (91) Usergroup License Use Licenseevents
- (108) Host License Use Licenseevents
- (109) Hostgroup License Use Licenseevents
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.
Apply the configurations shown in the Open iT Core Client.
Requirements
- An Open iT Core Client connected to an Open iT Core Server or a coexistent Open iT Core 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.
- Windows
- Unix
-
Go to the Components directory, which is by default in
C:\Program Files\OpeniT\Core\Configuration\Components
, and back up thelogfilecollector-tebis.xml
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, set the location of the Tebis log files, run the command:
Command Syntaxopenit_confinit -c "logfilecollector-tebis.logfilecollector.source.dir=<tebis_log_dir>"
where
<tebis_log_dir>
is the location of the Tebis log files.Exampleopenit_confinit -c "logfilecollector-tebis.logfilecollector.source.dir=C:\ProgramData\Tebis"
Sample Log File Content
Tebis TEBISFLD Version 3.5 R3 (174b9d4e32-1f6f06-10299-404d2)
27-MAR-2024 08:57:06 OPTION FILE: c:\program files\tebis_ag\tebis_flm_server\tebisfld.txt
27-MAR-2024 08:57:06 LICENCE FILE: C:\Program Files\Tebis_AG\Tebis_FLM_Server\licence\licence.key
20310772: Module TEBISFLD available until 15.04.2024
27-MAR-2024 08:57:07 Start server server01 on port 64200
27-MAR-2024 08:58:55 [domain\john.doe@host-123:3416] Feature 20310772-001 checked out
27-MAR-2024 08:59:00 [domain\john.doe@host-123:3416] Feature 20310772-001 checked in
27-MAR-2024 08:59:33 [domain\john.doe@host-123:3408] Feature 20310772-001 checked out
27-MAR-2024 09:52:51 [domain\jane.smith@host-456:3976] Feature 20310772-002 checked out
27-MAR-2024 09:53:03 [domain\jane.smith@host-456:3976] Feature 20310772-002 checked in
27-MAR-2024 09:55:16 [domain\jane.smith@host-456:3272] Feature 20310772-002 checked out
27-MAR-2024 09:56:13 [domain\jane.smith@host-456:3272] Feature 20310772-002 checked in
27-MAR-2024 09:57:33 [domain\jane.smith@host-456:2420] Feature 20310772-002 checked out
27-MAR-2024 09:58:12 [domain\jane.smith@host-456:2420] Feature 20310772-002 checked in
27-MAR-2024 10:44:34 [domain\alex.johnson@host-789:3992] Feature 20310772-001 checked out
27-MAR-2024 10:46:13 [domain\alex.johnson@host-789:3992] Feature 20310772-MOD-STL_PUT checked out
27-MAR-2024 11:54:45 [domain\john.doe@host-123:3408] Feature 20310772-001 checked in
27-MAR-2024 11:55:13 [domain\john.doe@host-123:2096] Feature 20310772-001 checked out
27-MAR-2024 12:13:14 [domain\alex.johnson@host-789:3992] Feature 20310772-MOD-SCAN checked out
27-MAR-2024 13:27:19 [domain\john.doe@host-123:2096] Feature 20310772-001 checked in
27-MAR-2024 13:52:41 [domain\john.doe@host-123:2828] Feature 20310772-001 checked out
27-MAR-2024 15:17:07 [domain\alex.johnson@host-789:3992] Feature 20310772-MOD-SCAN checked in
27-MAR-2024 15:17:07 [domain\alex.johnson@host-789:3992] Feature 20310772-MOD-STL_PUT checked in
27-MAR-2024 15:17:07 [domain\alex.johnson@host-789:3992] Feature 20310772-001 checked in
27-MAR-2024 15:18:17 [domain\alex.johnson@host-789:2808] Feature 20310772-001 checked out -
(Optional) Set the format of the Tebis log files if the log file has a different file extension than the default
*.log
, run the command:Command Syntaxopenit_confinit -c "logfilecollector-tebis.logfilecollector.source.pattern=<log_format>"
where
<log_format>
is the file extension of the Tebis log files.Exampleopenit_confinit -c "logfilecollector-tebis.logfilecollector.source.pattern=*.dbg"
-
Update the configuration file, run the command:
Command Syntaxopenit_confbuilder --client
Make sure no errors are encountered.
Advanced Configuration
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.
|
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. |
-
Go to the Components directory, which is by default in
/var/opt/openit/etc/Components
, and back up thelogfilecollector-tebis.xml
file. -
Go to the bin directory, which is by default in
/opt/openit/bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd /opt/openit/bin
-
Once in the directory, set the location of the Tebis log files, run the command:
Command Syntax./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "logfilecollector-tebis.logfilecollector.source.dir=<tebis_log_dir>"
where
<tebis_log_dir>
is the location of the Tebis log files.Example./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "logfilecollector-tebis.logfilecollector.source.dir=/var/opt/tebis"
Sample Log File Content
Tebis TEBISFLD Version 3.5 R3 (174b9d4e32-1f6f06-10299-404d2)
27-MAR-2024 08:57:06 OPTION FILE: c:\program files\tebis_ag\tebis_flm_server\tebisfld.txt
27-MAR-2024 08:57:06 LICENCE FILE: C:\Program Files\Tebis_AG\Tebis_FLM_Server\licence\licence.key
20310772: Module TEBISFLD available until 15.04.2024
27-MAR-2024 08:57:07 Start server server01 on port 64200
27-MAR-2024 08:58:55 [domain\john.doe@host-123:3416] Feature 20310772-001 checked out
27-MAR-2024 08:59:00 [domain\john.doe@host-123:3416] Feature 20310772-001 checked in
27-MAR-2024 08:59:33 [domain\john.doe@host-123:3408] Feature 20310772-001 checked out
27-MAR-2024 09:52:51 [domain\jane.smith@host-456:3976] Feature 20310772-002 checked out
27-MAR-2024 09:53:03 [domain\jane.smith@host-456:3976] Feature 20310772-002 checked in
27-MAR-2024 09:55:16 [domain\jane.smith@host-456:3272] Feature 20310772-002 checked out
27-MAR-2024 09:56:13 [domain\jane.smith@host-456:3272] Feature 20310772-002 checked in
27-MAR-2024 09:57:33 [domain\jane.smith@host-456:2420] Feature 20310772-002 checked out
27-MAR-2024 09:58:12 [domain\jane.smith@host-456:2420] Feature 20310772-002 checked in
27-MAR-2024 10:44:34 [domain\alex.johnson@host-789:3992] Feature 20310772-001 checked out
27-MAR-2024 10:46:13 [domain\alex.johnson@host-789:3992] Feature 20310772-MOD-STL_PUT checked out
27-MAR-2024 11:54:45 [domain\john.doe@host-123:3408] Feature 20310772-001 checked in
27-MAR-2024 11:55:13 [domain\john.doe@host-123:2096] Feature 20310772-001 checked out
27-MAR-2024 12:13:14 [domain\alex.johnson@host-789:3992] Feature 20310772-MOD-SCAN checked out
27-MAR-2024 13:27:19 [domain\john.doe@host-123:2096] Feature 20310772-001 checked in
27-MAR-2024 13:52:41 [domain\john.doe@host-123:2828] Feature 20310772-001 checked out
27-MAR-2024 15:17:07 [domain\alex.johnson@host-789:3992] Feature 20310772-MOD-SCAN checked in
27-MAR-2024 15:17:07 [domain\alex.johnson@host-789:3992] Feature 20310772-MOD-STL_PUT checked in
27-MAR-2024 15:17:07 [domain\alex.johnson@host-789:3992] Feature 20310772-001 checked in
27-MAR-2024 15:18:17 [domain\alex.johnson@host-789:2808] Feature 20310772-001 checked out -
(Optional) Set the format of the Tebis log files if the log file has a different file extension than the default
*.log
, run the command:Command Syntax./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "logfilecollector-tebis.logfilecollector.source.pattern=<log_format>"
where
<log_format>
is the file extension of the Tebis log files.Example./openit_confinit -r /var/opt/openit/ -d /var/opt/openit/etc/ -c "logfilecollector-tebis.logfilecollector.source.pattern=*.dbg"
-
Update the configuration file, run the command:
Command Syntaxopenit_confbuilder --client
Make sure no errors are encountered.
Advanced Configuration
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.
|
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. |
Activating Log Data Collection
These are the required steps to activate the collection of Tebis log data.
- Windows
- Unix
-
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, activate the collection of Tebis log data, run the command:
Command Syntaxopenit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.collect_tebis_licenselogs.general.active=true"
-
Go to the bin directory, which is by default in
/opt/openit/bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd /opt/openit/bin
-
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"
Advanced Configuration
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. |
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.
- Windows
- Unix
-
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, deactivate the collection of record log data, run the command:
Command Syntaxopenit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.preprocess_tebis_licenselogs-records.general.active=false"
-
Change the handling of event logs, run the command:
Command Syntaxopenit_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"
-
Change the data transfer schedule, run the command:
Command Syntaxopenit_oconfinit -u "collect_license_tebis-logs.root.scheduler.jobs.transfer_tebis_licenselogs.scheduling.start-triggers.trigger#1.job-name=preprocess_tebis_licenselogs-events"
-
Go to the bin directory, which is by default in
/opt/openit/bin
, run the command:Command Syntaxcd $BIN_DIR
Examplecd /opt/openit/bin
-
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"
-
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"
-
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 Core Server by following these steps:
- Windows
- Unix
-
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_tebis-logs
-
Verify that there are
archiver*.in
files created in the Core Server's 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_tebis-logs
-
Verify that there are
archiver*.in
files created in the incoming directory in your defined data_dir($ROOT_DATA_DIR)
upon Open iT Core Server installation.