You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Removed max number of topics per KI sentence. (#534)
* Removed max number of topics per KI sentence.
* Removed numerical limits and added link to service limits kb article.
* Error in mod docs build.
* Corrected formatting error in line 113.
* Corrected mod docs error.
* Applied reviewer's feedback.
Copy file name to clipboardExpand all lines: docs/kafka/metrics-monitoring-kafka/README.adoc
+15-53Lines changed: 15 additions & 53 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -87,76 +87,39 @@ As a developer or administrator, you can view metrics in {product-kafka} to visu
87
87
== Supported metrics in {product-kafka}
88
88
89
89
[role="_abstract"]
90
-
{product-kafka} supports the following metrics for Kafka instances and topics. In the {product-kafka} web console, a subset of these metrics is displayed in the *Dashboard* page of each Kafka instance.
90
+
{product-kafka} supports the following metrics for Kafka instances and topics. In the {product-kafka} web console, the *Dashboard* page of a Kafka instance displays a subset of these metrics. To learn more about the limits associated with both trial and production Kafka instance types, refer to https://access.redhat.com/articles/5979061[Red Hat OpenShift Streams for Apache Kafka Service Limits].
91
+
91
92
92
93
Cluster metrics::
93
94
+
94
95
--
95
-
* `kafka_namespace:haproxy_server_bytes_in_total:rate5m`: Number of incoming bytes per second for the cluster in the last five minutes. This metric represents all the data that producers are sending to topics in the cluster.
96
-
+
97
-
The Kafka instance type determines the maximum incoming byte rate, as shown in the following values:
96
+
* `kafka_namespace:haproxy_server_bytes_in_total:rate5m`: Number of incoming bytes per second for the cluster in the last five minutes. This ingress metric represents all the data that producers are sending to topics in the cluster.
97
+
The Kafka instance type determines the maximum incoming byte rate.
98
98
99
-
** 1 MiB per second for a trial instance
100
-
** 50 MiB per second for a production instance with a size of 1 streaming unit
101
-
** 100 MiB per second for a production instance with a size of 2 streaming units
102
-
103
-
* `kafka_namespace:haproxy_server_bytes_out_total:rate5m`: Number of outgoing bytes per second for the cluster in the last five minutes. This metric represents all the data that producers are receiving from topics in the cluster.
104
-
+
105
-
The Kafka instance type determines the maximum outgoing byte rate, as shown in the following values:
106
-
107
-
** 1 MiB per second for a trial instance
108
-
** 100 MiB per second for a production instance with a size of 1 streaming unit
109
-
** 200 MiB per second for a production instance with a size of 2 streaming units
99
+
* `kafka_namespace:haproxy_server_bytes_out_total:rate5m`: Number of outgoing bytes per second for the cluster in the last five minutes. This egress metric represents all the data that consumers are receiving from topics in the cluster.
100
+
The Kafka instance type determines the maximum outgoing byte rate.
110
101
111
102
* `kafka_namespace:kafka_server_socket_server_metrics_connection_count:sum`: Number of current client connections to the cluster. Kafka clients use persistent connections to interact with brokers in the cluster. For example, a consumer holds a connection to each broker it is receiving data from and a connection to its group coordinator.
112
-
+
113
-
The Kafka instance type determines the maximum number of active connections, as shown in the following values:
114
-
115
-
** 100 for a trial instance
116
-
** 3000 for a production instance with a size of 1 streaming unit
117
-
** 6000 for a production instance with a size of 2 streaming units
118
-
103
+
The Kafka instance type determines the maximum number of active connections.
119
104
* `kafka_namespace:kafka_server_socket_server_metrics_connection_creation_rate:sum`: Number of client connection creations per second for the cluster. Kafka clients use persistent connections to interact with brokers in the cluster. A constant high number of connection creations might indicate a client issue.
120
-
+
121
-
The Kafka instance type determines the maximum connection creation rate, as shown in the following values:
122
-
123
-
** 50 per second for a trial instance
124
-
** 100 per second for a production instance with a size of 1 streaming unit
125
-
** 200 per second for a production instance with a size of 2 streaming units
105
+
The Kafka instance type determines the maximum connection creation rate.
126
106
127
-
* `kafka_topic:kafka_topic_partitions:count`: Number of topics in the cluster. This does not include internal Kafka topics, such as `\__consumer_offsets` and `__transaction_state`. The maximum number of topics is 1000 for all Kafka instances.
107
+
* `kafka_topic:kafka_topic_partitions:count`: Number of topics in the cluster. This does not include internal Kafka topics, such as `\__consumer_offsets` and `__transaction_state`.
128
108
129
109
* `kafka_topic:kafka_topic_partitions:sum`: Number of partitions across all topics in the cluster. This does not include partitions from internal Kafka topics, such as `\__consumer_offsets` and `__transaction_state`.
130
-
+
131
-
The Kafka instance type determines the maximum number of partitions, as shown in the following values:
132
-
133
-
** 100 for a trial instance
134
-
** 1500 for a production instance with a size of 1 streaming unit
135
-
** 3000 for a production instance with a size of 2 streaming units
110
+
The Kafka instance type determines the maximum number of partitions.
136
111
--
137
112
138
113
Broker metrics::
139
114
+
140
115
--
141
116
* `kafka_broker_quota_softlimitbytes`: Maximum amount of storage, in bytes, for this broker before producers are throttled. When this limit is reached, the broker starts throttling producers to prevent them from sending additional data.
142
-
+
143
-
The Kafka instance type determines the maximum storage in the broker, as shown in the following values:
144
-
145
-
** 10 GiB for a trial instance
146
-
** 1000 GiB for a production instance with a size of 1 streaming unit
147
-
** 2000 GiB for a production instance with a size of 2 streaming units
148
-
117
+
The Kafka instance type determines the maximum storage in the broker.
149
118
150
119
* `kafka_broker_quota_totalstorageusedbytes`: Amount of storage, in bytes, that is currently used by partitions in the broker. The storage usage depends on the number and retention configurations of the partitions. This metric must stay below the `kafka_broker_quota_softlimitbytes` metric setting.
151
120
152
121
* `kafka_controller_kafkacontroller_global_partition_count`: Number of partitions in the cluster. Only the broker that is the current controller in the cluster reports this metric. Any other brokers report `0`. This count includes partitions from internal Kafka topics, such as `\__consumer_offsets` and `__transaction_state`. This metric is similar to the `kafka_topic:kafka_topic_partitions:sum` cluster metric.
153
-
+
154
-
The Kafka instance type determines the maximum storage in the broker, as shown in the following values:
155
-
156
-
** 100 for a trial instance
157
-
** 1500 for a production instance with a size of 1 streaming unit
158
-
** 3000 for a production instance with a size of 2 streaming units +
159
-
122
+
The Kafka instance type determines the maximum storage in the broker.
160
123
161
124
* `kafka_controller_kafkacontroller_offline_partitions_count`: Number of partitions in the cluster that are currently offline. Offline partitions cannot be used by clients for producing or consuming data. Only the broker that is the current controller in the cluster reports this metric. Any other brokers report `0`.
162
125
@@ -167,7 +130,7 @@ The Kafka instance type determines the maximum storage in the broker, as shown i
167
130
168
131
Topic metrics::
169
132
+
170
-
--
133
+
171
134
* `kafka_server_brokertopicmetrics_bytes_in_total`: Number of incoming bytes to topics in the instance.
172
135
173
136
* `kafka_server_brokertopicmetrics_bytes_out_total`: Number of outgoing bytes from topics in the instance.
@@ -181,7 +144,7 @@ Topic metrics::
181
144
* `kafka_topic:kafka_server_brokertopicmetrics_messages_in_total:rate5m`: Number of messages per second received by one or more topics in the instance in the last five minutes.
182
145
183
146
* `kafka_topic:kafka_log_log_size:sum`: Log size of each topic and replica, in bytes, across all brokers in the cluster.
184
-
--
147
+
185
148
186
149
[id="proc-viewing-metrics_{context}"]
187
150
== Viewing metrics for a Kafka instance in {product-kafka}
@@ -195,12 +158,11 @@ After you produce and consume messages in your services using methods such as li
195
158
.Procedure
196
159
* In the *Kafka Instances* page of the web console, click the name of the Kafka instance and select the *Dashboard* tab.
197
160
+
198
-
--
199
161
When you create a Kafka instance and add new topics, the *Dashboard* page is initially empty. After you start producing and consuming messages in your services, you can return to this page to view related metrics. For example, to use Kafka scripts to produce and consume messages, see {base-url}{kafka-bin-scripts-url-kafka}[_Configuring and connecting Kafka scripts with {product-long-kafka}_^].
200
162
201
163
NOTE: In some cases, after you start producing and consuming messages, you might need to wait several minutes for the latest metrics to appear. You might also need to wait until your instance and topics contain enough data for metrics to appear.
0 commit comments