Skip to content

Commit

Permalink
docs: rethinking metrics approach (#273)
Browse files Browse the repository at this point in the history
* docs: rethinking metrics approach

* docs: tweak metrics
  • Loading branch information
sterobin authored Oct 12, 2021
1 parent 29129a8 commit e1542bc
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions olm/quickstarts/rhosak-openshift-getting-started-quickstart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -199,15 +199,17 @@ spec:
failed: Try the steps again.
- title: Viewing metrics for a Kafka instance in Streams for Apache Kafka
description: >-
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.
After you create Kafka topics in your Kafka instance, you can start producing and consuming messages using methods such as [Kafka](https://kafka.apache.org/downloads) scripts, [Kafkacat](https://github.com/edenhill/kcat), or a [Quarkus](https://quarkus.io/) application.
1. In the **Kafka Instances** page of the web console, click the name of the Kafka instance for which you want to view metrics.
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.
1. 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.
- In the **Kafka Instances** page of the web console, click the name of the Kafka instance and select the **Dashboard** tab.
NOTE: In some cases, you might need to wait several minutes for the latest metrics to appear.
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.
The following metrics are available:
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.
After your topics contain data, the following metrics are available:
- **Kafka instance metrics**
- **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.
Expand All @@ -216,7 +218,7 @@ spec:
- **Total bytes**: Total bytes is the total incoming and outgoing bytes for all topics or for a selected topic in the Kafka instance. This metric enables you to assess data transfer in and out of your Kafka instance. To modify incoming and outgoing bytes, you can adjust topic message size or other topic properties as needed.
review:
instructions: |-
Are metrics displayed for your Kafka instance and topics? You might need to wait several minutes for the latest metrics to appear.
Did you note how to navigate to the instance **Dashboard** page to view metrics later?
failedTaskHelp: This task isn’t verified yet. Try the task again.
summary:
success: >-
Expand Down

0 comments on commit e1542bc

Please sign in to comment.