Create a test topic in Hermes using the Kafka client

task australia Updated Sep 10, 2026 1 min read create-hermes-topic.md
Raw file servicenow.com

Create a topic for sending and receiving test messages in the Hermes Kafka cluster.

Before you begin

Role required: admin

About this task

The full Hermes Kafka topic name is composed of the following elements:

Text
snc.<instance_name>.<namespace>.<app_id>.<topic_name>

where:

  • <instance_name> is the name of your instance

  • <namespace> is the namespace of the domain your Kafka topic belongs to (optional)

  • <app_id> is your application ID

    The topic you create belongs to this application. Specify either of the following:

    • sn_logstoanalytics for Log Export Service topics
    • sn_streamconnect for Stream Connect topics
  • <topic_name> is the unique name for your topic

Note: The full topic name is case-sensitive and limited to 200 characters.

Procedure

  1. Navigate to the config directory where you extracted Kafka.

    • For example, on Unix:

      Shell
      cd /home/user/Software/kafka/config
    • For example, on Windows:

      Shell
      cd C:\Software\kafka\config
  2. Configure a producer.

    1. Open the producer.properties file.

    2. Configure the following SSL properties:

      Text
      security.protocol=SSL
      ssl.truststore.password=<truststore password>
      ssl.truststore.location=<path to truststore.p12>
      ssl.truststore.type=PKCS12
      ssl.keystore.password=<keystore password>
      ssl.keystore.location=<path to keystore.p12>
      ssl.keystore.type=PKCS12
      ssl.key.password=<keystore password>

      Replace the following placeholder variables:

      • <truststore password> with your truststore password
      • <path to truststore.p12> with the path to your truststore file
      • <keystore password> with your keystore password
      • <path to keystore.p12> with the path to your keystore file
    3. Save your changes in plain text.

  3. Navigate to your Kafka directory.

  4. Create a test topic by running the following command:

    • Unix:

      XML
      ./bin/kafka-topics.sh --create --topic snc.<instance_name>.<namespace>.sn_<app_id>.<topic_name> --command-config ./config/producer.properties --bootstrap-server <instance_name>.service-now.com:4000,<instance_name>.service-now.com:4001,<instance_name>.service-now.com:4002,<instance_name>.service-now.com:4003
    • Windows:

      XML
      bin\windows\kafka-topics.bat --create --topic snc.<instance_name>.<namespace>.sn_<app_id>.<topic_name> --command-config config\producer.properties --bootstrap-server <instance_name>.service-now.com:4000,<instance_name>.service-now.com:4001,<instance_name>.service-now.com:4002,<instance_name>.service-now.com:4003

    Replace the following placeholder variables:

    • <instance_name> with your instance name (case-sensitive)
    • <namespace> with the namespace of the domain your Kafka topic belongs to (optional)
    • <app_id> with the application ID (case-sensitive)
    • <topic_name> with the unique topic name you want to use (case-sensitive)

Result

A test topic is created in the Hermes Kafka cluster.

What to do next

Produce test messages to a Hermes topic using the Kafka client

Search documentation
Search document titles and file paths on the australia branch