Viewing producer statistics

  • Release version: Zurich
  • Updated July 31, 2025
  • 2 minutes to read
    • Summarize
    Summarized using AI
    This content was generated using new OpenAI-powered functionality. Results are provided on an as is basis and are not guaranteed to be accurate or complete.

    Summary of Viewing producer statistics

    This feature enables ServiceNow customers to view detailed information and performance statistics about Stream Connect producers that publish messages from ServiceNow to Kafka topics. It provides insights into producer types, IDs, and the volume of data produced, helping customers monitor and manage their Kafka integrations effectively.

    Show full answer Show less

    Key Features

    • Producer Information: Stored in the Kafka Producers [syskafkaproducer] table, this includes producer type, ID, associated table name, topic, and domain. It captures details per topic and identifies producer types such as Kafka Producer step, scripted producers, or system executions.
    • Producer Performance Statistics: Captured in the Kafka Producer Statistics [syskafkaproducerstatistics] table, this includes hourly collected metrics like total bytes and messages produced to a Kafka topic, collection time, topic reference, and domain.
    • Access Control: Both tables require the Kafka Admin [kafkaadmin] role for read-only access. Records cannot be manually created, modified, or deleted, ensuring data integrity.
    • Navigation: Customers can access the Kafka Producers table via All > Integration Hub > Stream Connect > Producers to review producer details and drill down into specific statistics.

    Key Outcomes

    • Gain visibility into which ServiceNow components produce Kafka messages and their associated configurations.
    • Monitor producer performance with metrics on message volume and data size over time to identify trends or issues.
    • Ensure secure, role-based access to producer data for governance and operational monitoring.
    • Leverage detailed records to troubleshoot and optimize Kafka message production within the ServiceNow platform.

    View detailed information about a Stream Connect producer and its performance, including the producer type and ID, and the total number of bytes and messages produced to a topic.

    Stream Connect producers, including the Kafka Producer step and the ProducerV2 API, publish messages from ServiceNow to a Kafka topic. You can view detailed information and statistics for each producer.

    Each producer has a record that stores information about that producer, such as its type and ID. A producer might also have an associated statistics record with information about the producer's performance, including the number of bytes and messages it's produced to a topic.

    Producer details and statistics are covered in two tables.
    • Kafka Producers [sys_kafka_producer] table
    • Kafka Producer Statistics [sys_kafka_producer_statistics] table

    Both tables require the Kafka Admin [kafka_admin] role to view. These tables are read only and the records in them can't be manually created, updated, or deleted.

    Kafka Producers table

    The Kafka Producers [sys_kafka_producer] table captures producer information per topic. You can view the Kafka Producers table by navigating to All > Integration Hub > Stream Connect > Producers.

    Table 1. Kafka Producers table fields
    Field Description
    Number Unique identifier for the producer. Links to the producer record.
    Producer Type

    Type and version number for the producer.

    Each producer type is followed by the version number of the producer. For example, if the producer is the ProducerV2 API, the type listed is SCRIPT_V2.

    Options are:
    • ACTION: Kafka Producer step.
    • SCRIPT_ACTION: A producer called from within a scripted step in Workflow Studio.
    • SCRIPT: Producer API or ProducerV2 API.
    • SYSTEM: Any server-side execution in the ServiceNow Platform where the system can't identify any record associated with the execution.
    Producer Table

    Name of the table producing the record.

    For example, if the record is produced by a business rule, the table is Business Rule [sys_script]. If it's produced by the Kafka Producer step, it's Action Type [sys_hub_action_type_definition].
    Producer ID Reference to the record that produces the messages.
    Topic Reference to the Kafka topic record for the producer.
    Domain Name of the domain for the record producing the event.

    Kafka Producer Statistics

    The Kafka Producer Statistics [sys_kafka_producer_statistics] table captures producer statistics for each producer. Statistics are collected once per hour.

    Table 2. Kafka Producer Statistics table
    Field Description
    Topic Reference to the topic record for the producer.
    Collection Time Time the producer statistics were collected. Statistics are collected and reported every hour.
    Produced bytes Total number of bytes produced during the collection period.
    Produced messages Total number of messages produced during the collection period.
    Domain Name of the domain for the producer.
    You can also view the statistics for a specific producer by selecting the producer's record from the table.
    Figure 1. Sample producer record with statistics
    A producer record showing producer statistics at the bottom.