[WIP] Add support for ingesting logs from Kafka

[gibber9809]

Description

This PR adds support for ingesting log data from Kafka by integrating with the librdkafka C library. A user specifies the Kafka topic they want to consume from, the partition, the starting offset, and the number of Kafka messages they would like to consume on the command line. Users must also specify a path to a config file containing configuration options for kafka such as the list of bootstrapping brokers to connect to.

This configuration file is written in YAML, and may look something like:

kafka:
  boostrap.servers: "localhost:9092,localhost:9093"
  debug: "all"

and accepts any configuration option from the global configuration properties here.

The debug option enables internal debug logging from the librdkafka library, and is useful for diagnosing connection issues with Kafka.

Note that while this config file can be used for simple userid/password authentication it can't handle more advanced authentication flows. If we need to support some of the more advanced security options like authenticating with an OAUTH provider it seems like librdkafka requires us to implement some callback functions to reach out to an OAUTH broker on our own.

This PR is marked WIP since the end to end flow of ingesting logs from Kafka has not been fully validated.

Validation performed

• Validated that process exits without hanging when the Kafka broker can not be reached

[coderabbitai]

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[dkhwangbo]

@gibber9809 Hi. any update?

[gibber9809]

@gibber9809 Hi. any update?

Hi @dkhwangbo,

This pull request is on hold for now while we work on a few higher priority items, but we could reprioritize it depending on your needs.

Note that this draft implementation doesn't do much heavy lifting, so some changes may be required depending on your needs. In particular, the implementation just supports consuming a configurable number of messages from a given offset of a Kafka partition. The intention is that an external coordinator handles scheduling, worker failures, etc. We plan to add such a coordinator once a few other components are ready (e.g., a new scheduler), but that work is outside the scope of this PR.

We'd be interested to hear more about your specific use case for Kafka support. Feel free to reply here, or send us an email to [email protected].