m manifester.io
All Kafka APIs

PushTelemetry

This page encodes the smallest legal instance of the request and the response: numeric fields are zero, strings and byte arrays are empty, every array carries exactly one sample element, and any records field holds one empty 61-byte RecordBatch v2. Version 0 is a flexible version, so every struct is terminated by a uvarint tagged-field count and strings and arrays carry compact length-plus-one prefixes. Sizes below include the leading int32 size prefix.

API key
72
Encoded at
v0
Flexible versions
0+
Headers
req v2, resp v1
Request versions
0
Response versions
0
Request size
39 bytes
Response size
16 bytes
framerpc headerrequest bodyRecordBatchRecordresponse bodytagged_fields

Request

PushTelemetryRequest v0, request header v2, 39 bytes on the wire

byte layout (39 bytes, 16 bytes per row)

0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000
0010
0020

object tree

PushTelemetryRequest         message v0                                               [0x0000, 39B]
+-- Frame                                                                             [0x0000, 4B]   length-delimited framing
|   +-- size                 int32            = 35                                    [0x0000, 4B]   number of bytes that follow, patched after encoding
+-- RequestHeader            v2                                                       [0x0004, 11B]  common request header
|   +-- request_api_key      int16            = 72 (PushTelemetry)                    [0x0004, 2B]   numeric id of the API being invoked
|   +-- request_api_version  int16            = 0                                     [0x0006, 2B]   version of the API being invoked
|   +-- correlation_id       int32            = 0                                     [0x0008, 4B]   echoed back by the broker in the response
|   +-- client_id            nullable_string  = "" (int16 len=0)                      [0x000c, 2B]   always a non-flexible int16-prefixed string
|   +-- tagged_fields        uvarint          = 0                                     [0x000e, 1B]   number of tagged fields in the header
+-- PushTelemetryRequest     struct                                                   [0x000f, 24B]  message body, version 0
    +-- ClientInstanceId     uuid             = 00000000-0000-0000-0000-000000000000  [0x000f, 16B]  Unique id for this client instance.
    +-- SubscriptionId       int32            = 0                                     [0x001f, 4B]   Unique identifier for the current subscription.
    +-- Terminating          bool             = false                                 [0x0023, 1B]   Client is terminating the connection.
    +-- CompressionType      int8             = 0                                     [0x0024, 1B]   Compression codec used to compress the metrics.
    +-- Metrics              bytes            = empty (compact, len+1=1)              [0x0025, 1B]   Metrics encoded in OpenTelemetry MetricsData v1 protobuf format.
    +-- tagged_fields        uvarint          = 0                                     [0x0026, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 72,
  "type": "request",
  "listeners": ["broker"],
  "name": "PushTelemetryRequest",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
    {
      "name": "ClientInstanceId", "type": "uuid", "versions": "0+",
      "about": "Unique id for this client instance."
    },
    {
      "name": "SubscriptionId", "type": "int32", "versions": "0+",
      "about": "Unique identifier for the current subscription."
    },
    {
      "name": "Terminating", "type": "bool", "versions": "0+",
      "about": "Client is terminating the connection."
    },
    {
      "name": "CompressionType", "type": "int8", "versions": "0+",
      "about": "Compression codec used to compress the metrics."
    },
    {
      "name": "Metrics", "type": "bytes", "versions": "0+", "zeroCopy": true,
      "about": "Metrics encoded in OpenTelemetry MetricsData v1 protobuf format."
    }
  ]
}

Response

PushTelemetryResponse v0, response header v1, 16 bytes on the wire

byte layout (16 bytes, 16 bytes per row)

0
1
2
3
4
5
6
7
8
9
A
B
C
D
E
F
0000

object tree

PushTelemetryResponse      message v0        [0x0000, 16B]
+-- Frame                                    [0x0000, 4B]   length-delimited framing
|   +-- size               int32       = 12  [0x0000, 4B]   number of bytes that follow, patched after encoding
+-- ResponseHeader         v1                [0x0004, 5B]   common response header
|   +-- correlation_id     int32       = 0   [0x0004, 4B]   matches the correlation_id of the request
|   +-- tagged_fields      uvarint     = 0   [0x0008, 1B]   number of tagged fields in the header
+-- PushTelemetryResponse  struct            [0x0009, 7B]   message body, version 0
    +-- ThrottleTimeMs     int32       = 0   [0x0009, 4B]   The duration in milliseconds for which the request was throttled due to a q...
    +-- ErrorCode          int16       = 0   [0x000d, 2B]   The error code, or 0 if there was no error.
    +-- tagged_fields      uvarint     = 0   [0x000f, 1B]   number of tagged fields in this struct

kafka message schema (.json)

{
  "apiKey": 72,
  "type": "response",
  "name": "PushTelemetryResponse",
  "validVersions": "0",
  "flexibleVersions": "0+",
  "fields": [
    {
      "name": "ThrottleTimeMs", "type": "int32", "versions": "0+",
      "about": "The duration in milliseconds for which the request was throttled due to a quota violation, or zero if the request did not violate any quota."
    },
    {
      "name": "ErrorCode", "type": "int16", "versions": "0+",
      "about": "The error code, or 0 if there was no error."
    }
  ]
}