conduktor.io ↗

Kafka GetTelemetrySubscriptions Response Wire Format v0 — Binary Protocol Layout

What is GetTelemetrySubscriptions?

Clients call this (KIP-714) to negotiate which metrics they should push to the broker and at what interval. The broker controls what it wants to receive. A client with a stale subscription ID gets a new subscription back, prompting it to adjust its metric reporting.

Related Errors

CLUSTER_AUTHORIZATION_FAILED · INVALID_REQUEST · UNKNOWN_SUBSCRIPTION_ID · UNSUPPORTED_VERSION

Wire Diagram

Response Header · flexible
message_size int32 · 4B
correlation_id int32 · 4B
tagged var
GetTelemetrySubscriptionsResponse v0
ThrottleTimeMs int32 · 4B
ErrorCode int16 · 2B
ClientInstanceId uuid · 16B
SubscriptionId int32 · 4B
AcceptedCompressionTypes []int8
PushIntervalMs int32 · 4B
TelemetryMaxBytes int32 · 4B
DeltaTemporality bool · 1B
RequestedMetrics []string
tagged var

Schema & Example

Schema
{
  "ThrottleTimeMs": int32,
  "ErrorCode": int16,
  "ClientInstanceId": uuid,
  "SubscriptionId": int32,
  "AcceptedCompressionTypes": [int8],
  "PushIntervalMs": int32,
  "TelemetryMaxBytes": int32,
  "DeltaTemporality": bool,
  "RequestedMetrics": [string]
}
Example
{
  "ThrottleTimeMs": 0,
  "ErrorCode": 0,
  "ClientInstanceId": "550e8400-e29b-41d4-a716-446655440000",
  "SubscriptionId": 1,
  "AcceptedCompressionTypes": [...],
  "PushIntervalMs": 0,
  "TelemetryMaxBytes": 65536,
  "DeltaTemporality": true,
  "RequestedMetrics": ["value-1", "value-2"]
}