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.

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

Unclear metrics #184

Closed
gpiechnik2 opened this issue Dec 24, 2022 · 3 comments · Fixed by #189
Closed

Unclear metrics #184

gpiechnik2 opened this issue Dec 24, 2022 · 3 comments · Fixed by #189
Assignees
Labels
📖 Documentation Improvements or additions to documentation

Comments

@gpiechnik2
Copy link

From my point of view, the metrics made available in the summary are unclear. For example:

kafka_reader_fetch_bytes - Total bytes the reader fetches batches of messages from Kafka.

I understand that since kafka_reader_fetch_bytes is the amount in bytes, what is kafka_reader_fetch_size?

Is it possible to add to the documentation information about the returned metrics? Something similar was attempted by k6 developers, while the post is already outdated.

@mostafa
Copy link
Owner

mostafa commented Jan 2, 2023

Hey @gpiechnik2,

Thanks for the suggestion! I'd like to update the article and add more docs, but I need to find the time.

@mostafa mostafa added the 📖 Documentation Improvements or additions to documentation label Jan 3, 2023
@mostafa
Copy link
Owner

mostafa commented Jan 12, 2023

@gpiechnik2

I added a table explaining metrics as best as I can in #189. It'll be eventually merged.

@mostafa mostafa moved this from Todo to Doing in xk6-kafka Jan 12, 2023
@mostafa mostafa self-assigned this Jan 12, 2023
@github-project-automation github-project-automation bot moved this from Doing to Test in xk6-kafka Jan 23, 2023
@mostafa
Copy link
Owner

mostafa commented Jan 23, 2023

Hey @gpiechnik2,

The description of emitted metrics and their types are added to the README.

@mostafa mostafa moved this from Test to Release in xk6-kafka Jan 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
📖 Documentation Improvements or additions to documentation
Projects
Status: Release
Development

Successfully merging a pull request may close this issue.

2 participants