Outgoing byte rate
The metric provides the mean rate of outgoing bytes per second from each topic and each kafka broker at any given time.
Value will decrease as the volume and frequency of messages being read from the topic decreases.
Use cases
How much data are all applications consuming from my topic?
It could be useful to know how much data is being consumed from the topic or from the broker. So you can estimate your network needs better.
To do so, please, refer to the Using aggregator or Using groupBy. This examples will help to build a request for topic or for each broker based on your needs.
Basic usage
Please refer to the example outgoing byte rate provided in the API docs
This request is asking for outgoing byte rate per second, averaged over the entire provided rate-size [5M] (default value) from topic payment-events-stream on environment dev for last 15 minutes with the step-size of 1 minute.
Basic Request
Unresolved include directive in modules/ROOT/pages/self-service/client-metrics/topic/outgoing-byte-rate/outgoing-byte-rate.adoc - include::example$/client-metrics/topic/outgoing-byte-rate/simple-request.json[]
The below part of sample response, represents the outgoing byte rate from the topic from each kafka broker.
Basic Response
Unresolved include directive in modules/ROOT/pages/self-service/client-metrics/topic/outgoing-byte-rate/outgoing-byte-rate.adoc - include::example$/client-metrics/topic/outgoing-byte-rate/simple-response.json[]
This metric can be used to determine how much load is being generated by individual topics.
Advanced usage
Using aggregator
By adding aggregator to the request, the outgoing byte rate of the topic will be aggregated over all kafka brokers.
For instance asking for the sum aggregation function, will result in the sum of outgoing byte rate of the topic among all existing kafka brokers.
Request using sum aggregator
Unresolved include directive in modules/ROOT/pages/self-service/client-metrics/topic/outgoing-byte-rate/outgoing-byte-rate.adoc - include::example$/client-metrics/topic/outgoing-byte-rate/request-with-sum.json[]
The below response represents the outgoing bytes rate of the topic on a Kafka cluster.
Response using sum aggregator
Unresolved include directive in modules/ROOT/pages/self-service/client-metrics/topic/outgoing-byte-rate/outgoing-byte-rate.adoc - include::example$/client-metrics/topic/outgoing-byte-rate/response-with-sum.json[]
Using max instead of sum will result in maximum outgoing rate from a single broker.
Using groupBy
If you want to get response grouped by some label - you can use groupBy
Request using groupBy
Unresolved include directive in modules/ROOT/pages/self-service/client-metrics/topic/outgoing-byte-rate/outgoing-byte-rate.adoc - include::example$/client-metrics/topic/outgoing-byte-rate/request-with-groupBy.json[]
The below response represents the rate in bytes of the partition on each Kafka broker (pod), with data grouped by pod.
Response using groupBy
Unresolved include directive in modules/ROOT/pages/self-service/client-metrics/topic/outgoing-byte-rate/outgoing-byte-rate.adoc - include::example$/client-metrics/topic/outgoing-byte-rate/response-with-groupBy.json[]