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
Draft
Changes from 1 commit
Commits
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
Prev Previous commit
Next Next commit
fix: sub-headings
  • Loading branch information
harshini-rangaswamy committed Oct 16, 2024
commit f1c8012af89aefb0e1c3a7024be5612310c7cb81
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,14 @@ Before you download and run the tool, ensure you have the following:
- A valid Apache Kafka MirrorMaker 2 configuration file with the necessary source and
target cluster connectivity fields.

## Accessing the offset sync inspection tool
## Download the offset sync inspection tool

Download and run the **offset sync inspection tool** to analyze offset syncing in
MirrorMaker 2:

- [Download the offset sync inspection tool](https://github.com/aiven/kafka/releases/tag/mm2-offset-sync-inspector-0.1)

## Running the tool
## 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.

sync status and detect any issues with the offset syncing process.
Expand All @@ -48,7 +48,7 @@ To view all available options, run the help command:
./bin/kafka-mirrormaker-offset-sync-inspector.sh --help
```

## Understanding log messages and actions
## Log messages and actions

Below are common log messages generated by the tool, what they mean, and recommended
actions. If any issues arise, [create a support ticket](/docs/platform/howto/support) or
Expand Down