Documentation

Schema Registry

Adding a Schema Registry

You can add a new Schema Registry connection by using the Schema Registry toolbar button or the corresponding menu item under the File menu. In the Add Schema Registry dialog, enter a user-defined name and the Schema Registry endpoint. If your registry requires authentication, also enter the API key and API secret.

If your Schema Registry is protected with SSL, you can optionally provide the truststore location and password. If client certificate authentication is required, also enter the keystore location, keystore password, and keystore private key password. Offset Explorer validates the required fields and verifies that any truststore or keystore files you enter can be opened before the registry is saved.

Click Add to save the new Schema Registry. After it has been created, assign it to your server connection and connect to the registry to browse its Subjects.

Adding New Subject

Once the Schema Registry is connected, open its Subjects tab and add a new Subject using the Add button. In the Add Subject dialog, enter the Subject name, select the schema type, and paste the schema definition into the editor area.

Offset Explorer currently supports AVRO and PROTOBUF Subjects. The Subject name and schema are required. You can paste or edit larger schema definitions directly in the dialog.

Click Add to create the Subject in the connected Schema Registry. The new Subject will then appear in the list and can be associated with topics that use the same schema format.

Updating Schema

Select an existing Subject to view its properties. Offset Explorer shows the Subject name, type, schema ID, and the currently selected version. The version drop-down lets you load any existing schema version for review.

To register a new schema version, edit the schema in the editor and click Update. Offset Explorer sends the updated schema to the Schema Registry as a new version and then refreshes the version list. A confirmation message is shown with the new version number after the update succeeds.

If needed, you can also remove the currently selected schema version by clicking Delete. Deleting a version requires confirmation before it is permanently removed.

Topic Content Type

After adding a Schema Registry and pointing your server connection to it, select the topic that contains your Avro- or ProtoBuf-encoded messages. On the right-hand side, you need to change the content type of the key and/or value to Avro or ProtoBuf.

After making the changes, click the Update button to save them. You should now see your keys and/or values shown in a human-readable format in the Data tab.

Offset Explorer | UI Tool for Apache Kafka