Apache Pulsar · JSON Structure

Apache Pulsar Topic Stats Structure

TopicStats schema from Apache Pulsar

Type: object Properties: 9
Cloud NativeMessagingMulti-TenantPub-SubStreamingApacheOpen Source

TopicStats is a JSON Structure definition published by Apache Pulsar, describing 9 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

msgRateIn msgRateOut msgThroughputIn msgThroughputOut averageMsgSize storageSize backlogSize publishers subscriptions

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-pulsar/refs/heads/main/json-structure/apache-pulsar-topic-stats-structure.json",
  "description": "TopicStats schema from Apache Pulsar",
  "type": "object",
  "properties": {
    "msgRateIn": {
      "type": "double"
    },
    "msgRateOut": {
      "type": "double"
    },
    "msgThroughputIn": {
      "type": "double"
    },
    "msgThroughputOut": {
      "type": "double"
    },
    "averageMsgSize": {
      "type": "double"
    },
    "storageSize": {
      "type": "int32"
    },
    "backlogSize": {
      "type": "int32"
    },
    "publishers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "msgRateIn": {
            "type": "double"
          },
          "msgThroughputIn": {
            "type": "double"
          },
          "producerName": {
            "type": "string"
          },
          "producerId": {
            "type": "int32"
          }
        }
      }
    },
    "subscriptions": {
      "type": "object",
      "additionalProperties": {
        "type": "object",
        "properties": {
          "msgRateOut": {
            "type": "number"
          },
          "msgThroughputOut": {
            "type": "number"
          },
          "msgBacklog": {
            "type": "integer"
          },
          "consumers": {
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        }
      }
    }
  },
  "name": "TopicStats"
}