Monitoring the JetBrains License Manager with OpenLM

This document describes the steps required to monitor the JetBrains Floating License Server (FLS) with OpenLM in order to obtain license statistics.

Requirements

To query JetBrains FLS the following components must be installed:

1. OpenLM Server v5.6 or higher or Cloud configured in your organization
2. OpenLM Broker v4.10 or higher installed on the same machine as JetBrains FLS

Monitoring capabilities and features

The current monitoring capabilities available for the JetBrains FLS license manager through OpenLM Broker are as follows:

Additionally, using the Broker component allows for buffered communication and the ability to remotely start/stop the license manager service.

OpenLM Broker configuration

Diagram of how OpenLM interfaces with the JetBrains FLS

OpenLM Broker queries JetBrains FLS locally. This is done through the JetBrains FLS HTTP port. Once FLS is queried by Broker, the data is sent to OpenLM Server for processing.

Please note that OpenLM Broker must already be installed and configured to report to OpenLM Server before proceeding further.

Locating the JetBrains FLS token

The JetBrains reporting token must be configured before Broker can read license usage data.

1. If you already have the token configured, once you run the autodetect function (see below), Broker reads the service-config.properties file and inserts it automatically in the configuration options.

2. If you haven’t configured your reporting token yet and will be configuring Broker manually, follow the steps in the JetBrains manual. Once finished, make sure to copy or write the token down as you will need to edit the data_inquiry command later on.

Automatic OpenLM Broker configuration

1. To automatically configure OpenLM Broker with JetBrains FLS, click Detect in the bottom right corner of the Broker configuration tool window:
   
2. If the JetBrains FLS service or process is started, Broker will detect and configure most settings automatically.
3. It is recommended to manually check that the automatic configuration is working by going to Commands → data_query and clicking Execute.

Manual OpenLM Broker configuration

If auto-detect did not work, you can also add and configure the license manager manually. To do so:

1. Click Add Port.
2. Enter the JetBrains FLS port number (default: 8080).
3. Select JetBrains from the “License Manager Type” drop-down menu. Click Apply.
4. Select Commands. In the “Update path for commands” field enter or browse to the root folder where JetBrains FLS is installed. Click Update then Apply.
5. Select the data_inquiry node. Edit and replace the <TOKEN> placeholders with the token that you configured in step 3.1 of this document (e.g. http://SILV-PC:8080/licenses-report.json?token=283xxs8zum;http://SILV-PC:8080/tickets-report.json?token=283xxs8zum). Click Execute to verify the command, then click Apply.
6. Select “Vendor Name to Be Filled” under Vendors. Enter JetBrains in the “Vendor Name” field then click Apply.
7. Click Apply.
8. Click Restart Broker.
9. Follow the steps in section 4 (“OpenLM Server configuration”), below.

OpenLM Server configuration

Automatic OpenLM Server configuration through EasyAdmin

If you have followed the steps in the section above, OpenLM Broker should now be transmitting data to OpenLM Server. The final step is to approve the configuration in EasyAdmin:

1. Open the EasyAdmin interface either by accessing http://<OpenLM Server>:5015 in your browser or through Windows Start → OpenLM → OpenLM EasyAdmin User Interface.
2. In the License Manager – Server window select There are # servers pending approval.
   
3. Edit the Pending LM by double-clicking on the pending line or selecting the Pencil icon.
   
4. The Display name can be updated to a more friendly description (free text field) Please select Approve.
   
5. At this point, the JetBrains FLS has been automatically added to OpenLM Server and the configuration is complete.
   
   

Manual OpenLM Server configuration

If the automatic configuration has failed, you can manually configure OpenLM Server to connect to the OpenLM Broker installation located on the JetBrains FLS machine. This is done with the help of the OpenLM Server configuration tool (Windows Start → OpenLM → OpenLM Server)

The hostname and port settings must match those that have been configured for OpenLM Broker.

Adding a JetBrains FLS server

1. Select the License Servers tab.
2. Click Add.
3. From the Type drop-down menu, select OpenLM Generic.
4. Insert a description in the Description text box (e.g. “JetBrains FLS”)
5. Set the Time Zone to where the License Server physically resides.
6. Enter the Hostname and Port number of the machine where the JetBrains FLS is installed. The JetBrains FLS LM default port is 8080.
7. Is Triad Configuration box: unchecked?
8. Use Broker box: checked.
9. Click Save and close the Edit License Manager Panel.
   

OpenLM Server is now configured to monitor the incoming data from OpenLM Broker.

How to verify your JetBrains FLS configuration

To check if the JetBrains FLS license manager is being monitored correctly:

1. Open the EasyAdmin web application (access http://<OpenLM Server hostname>:5015 in your browser)
2. Click EasyAdmin Start → Widgets → License Manager -Servers. Verify that the configured license manager(s) appears in the server list. A green Up to date indicates an active connection to the license server.
   

Please note that sometimes it may take up to 3 minutes for the status indicator to change if this is a new connection.