This service is subject to change in terms of configuration, metrics, and logging.
To run Qlik Associative Engine with a paid license, you are required to run this service. Make sure that you have read and understood how licensing in Qlik Core works.
The Licenses service is available on Docker Hub as a Docker image: qlikcore/licenses.
It is developed by Qlik as closed source.
You need to configure the Licenses service with two environment variables
with your LEF serial number and
LICENSES_CONTROL_NBR with your LEF control number.
You also need to configure Qlik Associative Engine where to find it. You can do this by passing the following command line argument to the Qlik Associative Engine.
-S LicenseServiceUrl=<Licenses service URL>
To see an example of a license configuration, see the core-using-licenses repository.
In most Qlik Core deployments, you will only need to deploy a single instance of this service. This is because traffic between Qlik Associative Engine instances and the Licenses service is relatively low. It does however support multiple instances if needed.
For health checking, the service exposes
/health on port 9200, and it always responds with http status code
For Prometheus metrics scraping, the service exposes
/metrics on port 9200. It provides the following
metrics associated with your license:
|license_time_consumption||GAUGE||Number of license minutes consumed this month. This metrics is only showed if any minutes have been consumed.|
|license_time_total||GAUGE||The total amount of license minutes per month your license gives you.|
To see an example of how you can use these metrics to create dashboards of your license consumption, see the core-using-licenses repository.
This service complies with the Logging conventions.
By default, the minimum log level is
You can override the minimum logging level by providing the
LICENSES_LOG_LEVEL environment variable.
If no valid license exists or all license minutes are already consumed and the Qlik Associative Engine
is configured to run in licensed mode it will send a
push event on the websocket and then close it.
If during a license renewal there are no more license minutes a
push event will be sent from the Qlik Associative Engine and afterwards the websocket will be closed.