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

add: Content for Apache Kafka® MirrorMaker 2 offset sync log analysis #509

Draft
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

harshini-rangaswamy
Copy link
Contributor

@harshini-rangaswamy harshini-rangaswamy commented Oct 16, 2024

Describe your changes

Content for Apache Kafka® MirrorMaker 2 log analysis using the offset sync inspection tool.

preview - https://harshini-mm2-log-analysis.aiven-docs.pages.dev/docs/products/kafka/kafka-mirrormaker/howto/log-analysis-offset-sync-tool

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/.

Copy link

cloudflare-workers-and-pages bot commented Oct 16, 2024

Deploying aiven-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 9ff4207
Status: ✅  Deploy successful!
Preview URL: https://0aaa3b84.aiven-docs.pages.dev
Branch Preview URL: https://harshini-mm2-log-analysis.aiven-docs.pages.dev

View logs

sidebar_label: Offset sync log analysis
---

Analyze key log messages during data synchronization with Apache Kafka® MirrorMaker 2 using Aiven’s offset sync inspection tool.

Choose a reason for hiding this comment

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

By "log messages" do you mean like slf4j/printf/etc text streaming out of the services as they're running? Or Kafka topics/event streams/etc?

If it's the former, this title is inaccurate as this tool has nothing to do with debug logging.
If it's the latter, I think "log analysis" is a confusing term, as it makes me think of text logging.


## Run the tool

The offset sync inspection tool outputs logs in CSV format. Use the logs to check the

Choose a reason for hiding this comment

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

I think it's odd to say that the logs are CSV-formatted. It's "output", "data", or a "result", logs are something separate.

Comment on lines +138 to +139
<li>Enable TRACE logging for OffsetSyncStore in MirrorMaker 2 to review
translation activity.</li>

Choose a reason for hiding this comment

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

Is this something that the customer can do? Is this appropriate for this customer facing document?


<table>
<tr>
<th>Message ID</th>

Choose a reason for hiding this comment

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

I think this table has too many columns and doesn't render well on a web page.

Certain things can be combined or removed: The message ID is not part of the script output and it's only in this document to be used in talking about problems between customers and Support. It could be a superscript, or combined with the "Script message" column or whatever.

The Customer Action and Issue with Apache Kafka..." columns could also be combined, or the "Isssue with..." column could be discarded.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants