View Source KlifeProtocol.Messages.GetTelemetrySubscriptions (Klife Protocol v0.5.0)

Kafka protocol GetTelemetrySubscriptions message

Request versions summary:

Response versions summary:

Link to this section Summary

Functions

Returns the message api key number.

Receive a binary in the kafka wire format and deserialize it into a map.

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Receives a map and serialize it to kafka wire format of the given version.

Link to this section Functions

Returns the message api key number.

Link to this function

deserialize_response(data, version, with_header? \\ true)

View Source

Receive a binary in the kafka wire format and deserialize it into a map.

Response content fields:

  • throttle_time_ms: 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. (int32 | versions 0+)

  • error_code: The error code, or 0 if there was no error. (int16 | versions 0+)

  • client_instance_id: Assigned client instance id if ClientInstanceId was 0 in the request, else 0. (uuid | versions 0+)

  • subscription_id: Unique identifier for the current subscription set for this client instance. (int32 | versions 0+)

  • accepted_compression_types: Compression types that broker accepts for the PushTelemetryRequest. ([]int8 | versions 0+)

  • push_interval_ms: Configured push interval, which is the lowest configured interval in the current subscription set. (int32 | versions 0+)

  • telemetry_max_bytes: The maximum bytes of binary data the broker accepts in PushTelemetryRequest. (int32 | versions 0+)

  • delta_temporality: Flag to indicate monotonic/counter metrics are to be emitted as deltas or cumulative values (bool | versions 0+)

  • requested_metrics: Requested metrics prefix string match. Empty array: No metrics subscribed, Array[0] empty string: All metrics subscribed. ([]string | versions 0+)

Returns the current max supported version of this message.

Returns the current min supported version of this message.

Link to this function

serialize_request(map, version)

View Source

Receives a map and serialize it to kafka wire format of the given version.

Input content fields:

  • client_instance_id: Unique id for this client instance, must be set to 0 on the first request. (uuid | versions 0+)