Skip to content

Commit 333484a

Browse files
sterobinsmccarthy-ie
authored andcommitted
Rethinking metrics approach (redhat-developer#339)
* Rethinking metrics approach * Tweak metrics section * John feedback
1 parent e8c32d2 commit 333484a

1 file changed

Lines changed: 11 additions & 8 deletions

File tree

getting-started/README.adoc

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -272,20 +272,23 @@ endif::[]
272272
[id="proc-viewing-metrics_{context}"]
273273
== Viewing metrics for a Kafka instance in {product}
274274

275-
After you create Kafka topics in your Kafka instance and start producing and consuming messages in your services, use the *Dashboard* tab in the Kafka instance to view metrics for the instance and topics. These metrics help you understand the performance and data usage for your Kafka instance and topics.
275+
After you create Kafka topics in your Kafka instance, you can start producing and consuming messages using methods such as link:https://kafka.apache.org/downloads[Kafka] scripts, link:https://github.com/edenhill/kcat[Kafkacat], or a link:https://quarkus.io/[Quarkus] application.
276+
277+
After you produce and consume messages in your services, you can return to the Kafka instance in the web console and use the *Dashboard* page to view metrics for the instance and topics. The metrics help you understand the performance and data usage for your Kafka instance and topics.
276278

277279
.Prerequisites
278280
* You've created a Kafka instance and the instance is in *Ready* state.
279-
* You've created topics in your Kafka instance and you've started producing and consuming messages in your services.
281+
* You've created topics in your Kafka instance.
280282

281283
.Procedure
282-
. In the *Kafka Instances* page of the web console, click the name of the Kafka instance for which you want to view metrics.
283-
. Select the *Dashboard* tab and review the metrics for your Kafka instance and topics. Use the drop-down filters to refine the displayed metrics as needed.
284+
* In the *Kafka Instances* page of the web console, click the name of the Kafka instance and select the *Dashboard* tab.
284285
+
285286
--
286-
NOTE: In some cases, you might need to wait several minutes for the latest metrics to appear.
287+
When you create your Kafka instance and 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.
288+
289+
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.
287290

288-
The following metrics are available:
291+
After your topics contain data, the following metrics are available:
289292

290293
* *Kafka instance metrics*
291294
** *Used disk space*: Used disk space is the amount of disk space used by the Kafka brokers in the instance. This metric enables you to assess available disk space relative to the limit. To reduce used disk space, you can adjust topic retention time or other topic properties as needed.
@@ -295,10 +298,10 @@ The following metrics are available:
295298

296299
.Verification
297300
ifdef::qs[]
298-
* Are metrics displayed for your Kafka instance and topics? You might need to wait several minutes for the latest metrics to appear.
301+
* Did you note how to navigate to the instance *Dashboard* page to view metrics later?
299302
endif::[]
300303
ifndef::qs[]
301-
* Verify that metrics are displayed for your Kafka instance and topics. You might need to wait several minutes for the latest metrics to appear.
304+
* Verify that you know how to navigate to the instance *Dashboard* page to view metrics later.
302305
endif::[]
303306

304307
[role="_additional-resources"]

0 commit comments

Comments
 (0)