Basics

Reference documentation of all configuration and authentication options:

Key	Description	Default	Type	Required
lenses.ip	Bind HTTP at the given endpoint. Use in conjunction with `lenses.port`	0.0.0.0	string	no
lenses.port	The HTTP port to listen for API, UI and WS calls	9991	int	no
lenses.jmx.port	Bind JMX port to enable monitoring Lenses		int	no
lenses.license.file	The full path to the license file	license.json	string	no
lenses.secret.file	The full path to `security.conf` for security credentials	security.conf	string	no
lenses.storage.directory	The full path to a directory for Lenses to store state		string	no
lenses.sql.execution.mode	Streaming SQL mode `IN_PROC`, `KUBERNETES` or `CONNECT`	IN_PROC	string	no
lenses.kafka.brokers	The Kafka bootstrap brokers to connect to		string	yes
lenses.kafka.metrics	An object to provide broker JMX connection info		object	no
lenses.kafka.connect.clusters	An object with kafka-connect cluster connection info		object	no
lenses.schema.registry.urls	An object with Schema Registry connection info		object	no
lenses.zookeeper.hosts	An object with ZK connection info		object	no
lenses.offset.workers	Number of workers to monitor topic offsets	5	int	no
lenses.telemetry.enable	Enable telemetry data collection	true	boolean	no
lenses.kafka.control.topics	An array of topics to be treated as “system topics”		array	no
lenses.grafana	Add your Grafana url i.e. http://grafanahost:port		string	no
lenses.api.response.cache.enable	If 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`.	false	boolean	no