Manage your license
Apply your license
In order to enjoy your Enterprise Gateway plan, you'll have to configure every Gateway deployment to use the license key provided.
This license has to be set as an environment variable in your Gateway configuration:
GATEWAY_LICENSE_KEY="YOUR_LICENSE_HERE"
Verify your license
In Kafka
You can check that your license has been used to launch the Gateway by looking at the license internal topic it has created.
The default name of this topic is _conduktor_gateway_license
, but it might be different if:
- You have set another name via
GATEWAY_LICENSE_TOPIC
- You have set the
GATEWAY_CLUSTER_ID
, then the topic will be_conduktor_${GATEWAY_CLUSTER_ID}_license
.
In this topic, you'll find the license expiration date.
- Enterprise plan
- Free plan
{
"io.conduktor.proxy.avro.schema.AvroLicense.ConduktorLicense": {
"token": "YOUR_LICENSE_HERE"
}
}
{
"io.conduktor.proxy.avro.schema.AvroLicense.FreeLicense": {
"expirationDate": "1730280320532"
}
}
In the Gateway logs
You can check that your license has been applied correctly by looking at the Gateway logs.
When the Gateway starts, it will log the license information:
[INFO] [PersistentLicenseService:114] - Applied new license with expiry: 2026-06-29T00:00:00.000Z
[INFO] [PersistentLicenseService:86] - Enterprise license found, valid until: 2026-06-29T00:00:00.000Z
In the Gateway metrics
You can monitor the days left before expiration using this metric from the Gateway metrics endpoint: gateway_license_remaining_days
.
We highly recommend you to set up an alert for when the license is about to expire.
License expiration
One week before expiration, you'll see this warning in your logs:
License will expire in less than X day(s)! You need to renew your license to continue using Conduktor Gateway. Checkout our documentation (https://docs.conduktor.io/gateway/get-started/license-management/) if unsure how to set the license.
After expiration, the Gateway will continue running, until the next restart, and will log a warning every hour that your license has expired:
License has expired! You need to add a valid license to continue using Conduktor Gateway. Checkout our documentation if unsure how to set the license.
The Gateway container will then fail on restart with a "license expired error".
Change the License
To replace your license, change the GATEWAY_LICENSE_KEY
environment variable and deploy the Conduktor Gateway container again.