4.0

You are viewing documentation for an older version of Lenses.io View latest documentation here

Basics

Reference documentation of all configuration and authentication options:

KeyDescriptionDefaultTypeRequired
lenses.ipBind HTTP at the given endpoint. Use in conjunction with lenses.port0.0.0.0stringno
lenses.portThe HTTP port to listen for API, UI and WS calls9991intno
lenses.jmx.portBind JMX port to enable monitoring Lensesintno
lenses.license.fileThe full path to the license filelicense.jsonstringno
lenses.secret.fileThe full path to security.conf for security credentialssecurity.confstringno
lenses.storage.directoryThe full path to a directory for Lenses to store statestringno
lenses.sql.execution.modeStreaming SQL mode IN_PROC, KUBERNETES or CONNECTIN_PROCstringno
lenses.kafka.brokersThe Kafka bootstrap brokers to connect tostringyes
lenses.kafka.metricsAn object to provide broker JMX connection infoobjectno
lenses.kafka.connect.clustersAn object with kafka-connect cluster connection infoobjectno
lenses.schema.registry.urlsAn object with Schema Registry connection infoobjectno
lenses.zookeeper.hostsAn object with ZK connection infoobjectno
lenses.offset.workersNumber of workers to monitor topic offsets5intno
lenses.telemetry.enableEnable telemetry data collectiontruebooleanno
lenses.kafka.control.topicsAn array of topics to be treated as “system topics”arrayno
lenses.grafanaAdd your Grafana url i.e. http://grafanahost:portstringno
lenses.api.response.cache.enableIf enabled, it disables client cache on the Lenses API HTTP responses by adding these HTTP Headers: Cache-Control: no-cache, no-store, must-revalidate, Pragma: no-cache, and Expires: -1.falsebooleanno