Skip to main content
Version: 10.2

Sentinel RMS License Manager

Introduction​

Open iT supports Sentinel RMS usage reporting. The following sections will guide you on the required configuration for license manager utility polling and log file parsing.

warning

Apply the configurations shown in the Open iT Core Client.

Configuring License Manager Utility Polling​

Open iT polls the license servers at regular intervals to get the current status of its license use and availability.

An Open iT Core Client is installed on your license server for this collection. The data collector/preprocessor gathers the current license usage information from the license manager every hour using a 5-minute sample interval, triggering the data collection process. It also processes the gathered license usage. Once the data is preprocessed, it is transmitted to the Core Server, according to the client's timezone, for further storage, completing the license usage data collection and processing.

License Manager Utility Polling Workflow

License Manager Utility Polling Workflow

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

The following sections will guide you in setting up the necessary configuration to collect and send the required data to the server.

Requirements​

Configuring Data Collection​

These are the required steps to activate and configure collection of Sentinel RMS usage data.

warning

Make sure that you have a working version of lsmon in the bin directory, which is by default in C:\Program Files\OpeniT\Core\bin.

warning

If configuring Sentinel RMS remotely, make sure that the lsapiw32.dll is in the same directory as lsmon.

  1. Go to the Components directory, which is by default in C:\Program Files\OpeniT\Core\Configuration\Components, and back up the licpoll.xml configuration file.

  2. Open a command prompt with Administrator level privileges.

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

  4. Once in the directory, activate the collection of Sentinel RMS data, run the command:

    Command Syntax
    openit_confinit -c "licpoll.license-types.sentinel-sample.active=true"

  5. Set the license server name used by the Sentinel RMS license server, run the command:

    Command Syntax
    openit_confinit -c "licpoll.license-types.sentinel-sample.status-command.arguments=<hostname>"
    Example
    openit_confinit -c "licpoll.license-types.sentinel-sample.status-command.arguments=desktop123win"

  6. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

Refer to the Sentinel RMS Data Collection Configuration table to learn more about Sentinel RMS configuration in licpoll.xml.

Object NameAccepted ValueDescription
activeBoolean (true or false)Setting this to true activates Sentinel RMS usage data collection.
typeString (i.e., Sentinel)The license manager type.
intervalTimespan (e.g., P30S, P5M, P1H)The span of time between each polling round (it is recommended to set a value no less than P1M).
offsetTimespan (e.g., P30S, P5M, P1H)The span of time the aligned poll time decided by interval is shifted.
product-nameString (e.g., server;daemon)This object is defined if a vendor license name other than the default Sentinel=%server%;sentinel will be used.
end-triggerString (i.e., Enter to continue)The line that will be the end trigger.
status-commandFileName (e.g., ${OpeniT. directories.bin}/ lsmon)The binary used to obtain status from the license manager.
status-command.argumentsString (e.g., desktop123win)The arguments used for the status command.
Sentinel RMS Data Collection Configuration

Verifying Data Collection​

After configuration, you can verify that the data is collected 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_licpoll -# 1

  4. Verify that the temp directory, which is by default in C:\ProgramData\OpeniT\Data\temp, contains a LicPoll directory containing .data and status-*.log files.

note

Continue reading if you need to configure log file parsing. If not, here are some suggested readings.

Configuring Log File Parsing​

Open iT supports 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.

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 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 Sentinel RMS log files.

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

  2. Open a command prompt with Administrator level privileges.

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

  4. Once in the directory, set the location of the Sentinel RMS log files, run the command:

    Command Syntax
    openit_confinit -c "logfilecollector-sentinel.logfilecollector.source.dir=<sentinel_log_dir>"

    where <sentinel_log_dir> is the location of the Sentinel RMS log files.

    Example
    openit_confinit -c "logfilecollector-sentinel.logfilecollector.source.dir=C:\Sentinel\home\logs"
    Sample Log File Content
    # Startup Sentinel RMS License Manager v1.6.0.0221 Fri Mar 11 01:00:06 2024  2757071517 9957F0B87F2EAE8F 781 15208 v1.0
    2 2 MTg5NzY= Fri Mar 11 01:00:06 2024  2757071517 AVEVA659 v1.0 15 1 0 11898B3FCA83B1C5 7784A31FD8124E0E 1.6.0.0221 1 P=NONE;S=HUD;H=_7784A31FD8124E0E - - - - - 0 - - - OTU= 1024106 MTk1MTk5Mw==
    2 2 MTg5NzY= Fri Mar 11 10:36:41 2024  2757006112 AVEVA659 v1.0 0 2 0 5A9CC37D8873D931 F289009D30021C22 1.6.0.0221 1 P=NONE;S=HUD;H=_DIFF009D30021C22 - - - - - 0 - - - NDkyNQ== 535553 MTIzNzMzMQ==
    2 2 MTg5NzY= Fri Mar 11 10:57:13 2024  2757007344 AVEVA659 v1.0 2 1 1232 5A9CC37D8873D931 F289009D30021C22 1.6.0.0221 1 P=NONE;S=HUD;H=_DIFF009D30021C22 - - - - - 0 - - - NTA3NQ== 89098 NjgxNTA5
    2 2 MTg5NzY= Fri Mar 11 16:53:30 2024  2758128721 AVEVA659 v1.0 0 2 0 67B696468610B879 B23C3A7711E4D5CB 1.6.0.0221 1 P=NONE;S=HUD;H=_DIFF3A7711E4D5CB - - - - - 0 - - - NzY4Mg== 580672 MTM5NTczNg==
    2 2 MTg5NzY= Fri Mar 11 20:35:03 2024  2758141014 AVEVA659 v1.0 2 1 92149 11898B3FCA83B1C5 7784A31FD8124E0E 1.6.0.0221 1 P=NONE;S=HUD;H=_7784A31FD8124E0E - - - - - 0 - - - ODI3NA== 527317 ODU4NjQ0
    2 2 MTg5NzY= Fri Mar 11 20:42:14 2024  2758142445 AVEVA659 v1.0 0 2 0 11898B3FCA83B1C5 7784A31FD8124E0E 1.6.0.0221 1 P=NONE;S=HUD;H=_7784A31FD8124E0E - - - - - 0 - - - ODI4OQ== 1415913 MjcxMjUzMQ==
    2 2 MTg5NzY= Sat Mar 12 01:00:07 2024  2758157918 AVEVA659 v1.0 13 1 0 11898B3FCA83B1C5 7784A31FD8124E0E 1.6.0.0221 1 P=NONE;S=HUD;H=_7784A31FD8124E0E - - - - - 0 - - - OTU5Mw== 1466525 MzQ1MDY3OA==
    2 2 MTg5NzY= Sat Mar 12 01:00:07 2024  2758157918 AVEVA659 v1.0 13 0 0 67B696468610B879 B23C3A7711E4D5CB 1.6.0.0221 1 P=NONE;S=HUD;H=_DIFF3A7711E4D5CB - - - - - 0 - - - OTU5NA== 285487 MTc1MjAxMg==

  5. Update the configuration file, run the command:

    Command Syntax
    openit_confbuilder --client

    Make sure no errors are encountered.

Advanced Configuration

Refer to the Sentinel RMS Log File Collection Configuration table to learn more about Sentinel RMS configuration in logfilecollector-sentinel.xml.

Object NameAccepted ValueDescription
source.dirDirName (e.g., C:\Sentinel \home\logs)Location of the Sentinel RMS log files.
source.patternString (i.e., *.log)The glob pattern identifying source files in the source directory.
source.seenString (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.cmplinesInteger (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.dirDirName (i.e., ${OpeniT. directories.temp}/ LogFileCollector)This is the location of the directory containing the collected log data.
target.moduleString (i.e., license)The target type of module (in general).
target.datatypeString (i.e., sentinel)The specific type of target data.
target.intervalTimespan (e.g., P30S, P5M, P1D)The span of time between collector runs.
target.rotation-sizeInteger (e.g., 6, 10, 20)The log file rotates if it goes beyond the number (in mb) defined.
target.rotation-globString (e.g., *)The glob pattern to match before the log file rotates.
Sentinel RMS Log File Collection Configuration

Activating Log Data Collection​

These are the required steps to activate collection of Sentinel RMS 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 Sentinel RMS log data, run the command:

    Command Syntax
    openit_oconfinit -u "collect_license_sentinel-logs.root.scheduler.jobs.collect_sentinel_licenselogs.general.active=true"
Advanced Configuration

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

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

Attribute NameAccepted ValueDescription
max-instancesUint (e.g., 5, 8, 9)The number of instances allowed to run at the same time.
max-handlingString (end-oldest, end-all-old, or end-new)The action done upon reaching the maximum number of instances:
  • end-oldest - Specify this option to stop/kill the oldest instance and start a new one.
  • end-all-old - Specify this option to stop/kill all running instances before starting the new one.
  • end-new - Specify this option to prevent a new instance from starting.
end-timeoutTimespan (e.g., P30S, P5M, P1H)The maximum waiting time before terminating a running instance.
quarantineTimespan (e.g., P30S, P5M, P1H)The waiting time before starting a new instance after a previous one.
Sentinel RMS 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_sentinel-logs.root.scheduler.jobs.preprocess_sentinel_licenselogs-records.general.active=false"

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

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

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

    Command Syntax
    openit_oconfinit -u "collect_license_sentinel-logs.root.scheduler.jobs.transfer_sentinel_licenselogs.scheduling.start-triggers.trigger#1.job-name=preprocess_sentinel_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:

  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_logfilecollector -c "C:\Program Files\OpeniT\Core\Configuration\logfilecollector-sentinel.conf"

  4. Verify that there are *.data files created in the LogFileCollector directory, which is by default in C:\Program Files\OpeniT\Core\Log\temp\LogFileCollector.

Next Steps?​

Renaming Vendor License
Renaming Features
Create and Add Report
License Monitor