BASIS License Service Metrics
Access to this feature requires an active Software Asset Management (SAM) subscription. See Benefits of ‘Software Asset Management' Feature Line.
The BASIS License Server provides metrics. For an overview of how to use these metrics, see BBj Metrics Overview.
Server Prometheus Metrics
The BLS Server provides Prometheus metrics via the configured metrics port. This port can be configured in the blsserver.conf file as metrics_port, and defaults to 10001. Prometheus can be configured to read these metrics using this URL:
http://<BLS server host>:<metrics port>/metrics
For example, using localhost and the default metrics port, the URL would be as follows:
http://localhost:10001/metrics
If you read the URL manually, you will get a textual dump of the current metrics. BASIS recommends that you use firewall rules to restrict access to the metrics port to the Prometheus host.
General
Metrics about the server in general.
| Name | Description | ||
|---|---|---|---|
| bbj_license_server_info |
License server information
|
||
| ... | Various JVM metrics (provided by Prometheus) |
Server
Metrics about the service itself, socket connections to the server, and how many of those connections did not end up being valid logins.
| Name | Description | ||
|---|---|---|---|
| bbj_license_server_connections_count | Current number of license server connections | ||
| bbj_license_server_connections_total | Total number of license server connections | ||
| bbj_license_server_invalid_clients_total | Total number of license server invalid clients | ||
| bbj_license_server_invalid_logins_total |
Total number of license server invalid logins
|
Server Logins
Metrics about valid server logins.
| Name | Description | ||
|---|---|---|---|
| bbj_license_server_logins_count |
Current number of license server logins
|
||
| bbj_license_server_logins_total |
Total number of license server logins
|
Server Requests
Metrics about individual server requests. Note that all requests do not result in responses ("CLOSE" and "PUSH_CHECKIN_LICENSE" are examples). Also note that each "CHECKOUT_LICENSE" request is not necessarily paired with a "CHECKIN" since connection termination will automatically result in all licenses held by the connection being checked in.
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
| bbj_license_server_requests_count |
Current number of license server requests
|
||||||
| bbj_license_server_requests_total |
Total number of license server requests
|
||||||
| bbj_license_server_responses_total |
Total number of license server responses
|
Server Orphans
Metrics about orphaned connections. If a client is disconnected without sending a "CLOSE" message then the connection becomes orphaned for a short period (default 1 minute), holding onto its licenses. This is because the failure to send a "CLOSE" message indicates an unexpected issue that may just be a transient network problem and the client will be reconnecting shortly and resuming the license checkouts.
| Name | Description | ||
|---|---|---|---|
| bbj_license_server_orphans_count |
Current number of license server orphans
|
||
| bbj_license_server_orphans_total |
Total number of license server orphans
|
Licenses
Metrics about actual license checkouts and failures. These metrics will show how many licenses a customer is using over time and what failures are happening.
| Name | Description | ||||||
|---|---|---|---|---|---|---|---|
| bbj_license_count |
Number of existing licenses (from the license file)
|
||||||
| bbj_license_expiration_time_ms |
License expiration timestamp in ms (from the license file)
|
||||||
| bbj_license_checkouts_count |
Current number of license checkouts
|
||||||
| bbj_license_checkouts_total |
Total number of license checkouts
|
||||||
| serial_number |
License serial number
|
||||||
| bbj_license_failed_checkouts_count |
Total number of failed license checkouts
|