Overview

This page describes an overview of the Lenses Agent configuration.

The Agent configuration is split between two files.

1. lenses-agent.conf

2. provisioning.yaml

lenses-agent.conf holds all the database connections and low-level options for the agent.

In the provisioning.yaml you define how to connect to your Kafka cluster, Schema Registries, Kafka Connect clusters and HQ. See Provisioning for more information.

The provisioning.yaml is watched by the Agent, so any changes made, if valid, are applied.

JSON Schema Support

To help with creating a provisioning.yaml from your IDE you can use the provided JSON schema support. They are available in the following repo.

View JSON Schemas

Add the following to the top of your YAML file

# yaml-language-server: $schema=https://raw.githubusercontent.com/lensesio/json-schemas/refs/heads/main/agent/provisioning.schema.json

You will then get auto completion and validation, for example, at the start of a line type kafka at the start of the line to trigger the default snippets (templates) for Kafka.

For Schema registry, type Schema, Connect type Connect, Alerting type altering, etc.

You require at minimum a lenses-hq connection and a kafka connection for the schema to be valid.

You do not need to use the default snippets, you can also use the auto completion for each connection type.