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

Jump to bottom

fix: improve Kafka Prometheus metrics docs #292

Merged
merged 7 commits into from
Jul 16, 2024
Merged

fix: improve Kafka Prometheus metrics docs #292

merged 7 commits into from
Jul 16, 2024

Conversation

harshini-rangaswamy
Copy link
Contributor

@harshini-rangaswamy harshini-rangaswamy commented Jun 21, 2024 •
edited

Describe your changes

  • Converted the metrics list from a bullet list to a table format for a cleaner and more organized display.
  • Added missing descriptions for several metrics to provide clearer insights.
  • Improved the overall documentation for Kafka Prometheus metrics. DOC-617.
  • Included new metrics specific to tiered storage.

Checklist

  • The first paragraph of the page is on one line.
  • The other lines have a line break at 90 characters.
  • I checked the output.
  • I applied the style guide.
  • My links start with /docs/.

@harshini-rangaswamy harshini-rangaswamy self-assigned this Jun 21, 2024
@github-actions github-actions bot added service/kafka tech Relates to technical updates of the docs platform. labels Jun 21, 2024
@cloudflare-pages Cloudflare Pages
Copy link

cloudflare-pages bot commented Jun 21, 2024 •
edited

Deploying aiven-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 0ad8b5f
Status: ✅  Deploy successful!
Preview URL: https://81b9eb28.aiven-docs.pages.dev
Branch Preview URL: https://harshini-kafka-prometheus-fi.aiven-docs.pages.dev

View logs

@harshini-rangaswamy harshini-rangaswamy added the review/SME An SME must review the PR. label Jun 28, 2024
@harshini-rangaswamy harshini-rangaswamy marked this pull request as ready for review July 8, 2024 08:07
@harshini-rangaswamy harshini-rangaswamy requested a review from a team as a code owner July 8, 2024 08:07
giuseppelillo
giuseppelillo approved these changes Jul 12, 2024
View reviewed changes
Copy link
Contributor

@giuseppelillo giuseppelillo left a comment

Choose a reason for hiding this comment

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

LGTM, just left a small comment

docs/products/kafka/reference/kafka-metrics-prometheus.md Outdated Show resolved Hide resolved
@harshini-rangaswamy harshini-rangaswamy added review/TW A TW must review the PR. Comes after review/SME. and removed review/SME An SME must review the PR. labels Jul 15, 2024
wojcik-dorota
wojcik-dorota approved these changes Jul 16, 2024
View reviewed changes
Copy link
Contributor

@wojcik-dorota wojcik-dorota left a comment

Choose a reason for hiding this comment

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

LGTM! A few ideas for possible improvements

docs/products/kafka/reference/kafka-metrics-prometheus.md Outdated Show resolved Hide resolved
docs/products/kafka/reference/kafka-metrics-prometheus.md Outdated Show resolved Hide resolved
docs/products/kafka/reference/kafka-metrics-prometheus.md Outdated Show resolved Hide resolved
docs/products/kafka/reference/kafka-metrics-prometheus.md Outdated Show resolved Hide resolved
docs/products/kafka/reference/kafka-metrics-prometheus.md Outdated Show resolved Hide resolved
@harshini-rangaswamy harshini-rangaswamy merged commit e6636e7 into main Jul 16, 2024
4 checks passed
@harshini-rangaswamy harshini-rangaswamy deleted the harshini-kafka-prometheus-fix branch July 16, 2024 11:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@giuseppelillo giuseppelillo giuseppelillo approved these changes

@wojcik-dorota wojcik-dorota wojcik-dorota approved these changes

@juha-aiven juha-aiven Awaiting requested review from juha-aiven

Assignees

@harshini-rangaswamy harshini-rangaswamy

Labels
review/TW A TW must review the PR. Comes after review/SME. service/kafka tech Relates to technical updates of the docs platform.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

None yet
3 participants
@harshini-rangaswamy @giuseppelillo @wojcik-dorota