Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: rethinking metrics approach #273

Merged
merged 2 commits into from
Oct 12, 2021
Merged

docs: rethinking metrics approach #273

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3950147
docs: rethinking metrics approach
sterobin Oct 11, 2021
4817d1b
docs: tweak metrics
sterobin Oct 11, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions olm/quickstarts/rhosak-openshift-getting-started-quickstart.yaml
View file
Open in desktop
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?
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not super clear what user will need to do

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@wtrocki Right, it's just an interim section until we have enough metrics content for a separate story, at which point we won't need to include this in the getting started anymore. So the main objective for the user is literally just to note how to get to this page and no need to do anything yet. Just will need to know that it exists to return so they can view metrics if needed later.

failedTaskHelp: This task isn’t verified yet. Try the task again.
summary:
success: >-
Expand Down