Bug Reports and Feature Requests
You can report an issue in the Fluss issue tracker.
Issue Reporting Guide
Considerations before opening an issue:
-
Make sure that the issue corresponds to a genuine bug or enhancement request. Exceptions are made for typos in documentation files, which can be reported directly.
-
Provide a clear and descriptive title. Use component labels (such as
component=server,component=client,component=connector,component=docs) to help categorize your issue and make it easier to filter and search. -
Fill out the issue template to describe the problem or enhancement clearly. Please describe it such that maintainers understand the context and impact from the description, not only from reproduction steps.
-
Make sure that you have searched existing issues to avoid duplicates.
-
Each issue should address only one problem or enhancement, not mix up multiple unrelated topics.
Looking for what to report
- If you have encountered a bug, you can proceed to the bug reporting process.
- If you have a feature idea, you can proceed to the feature request process.
How to report a bug
When filing an issue, make sure to answer these five questions:
Environment:
- What version of Fluss are you using?
- What operating system and processor architecture are you using?
Steps to reproduce: 3. What did you do?
Expected vs Actual behavior: 4. What did you expect to see? 5. What did you see instead?
Troubleshooting questions should be posted on:
How to suggest a feature or enhancement
Fluss aims to provide a unified streaming storage for real-time analytics, offering seamless data ingestion, processing, and querying capabilities with strong consistency guarantees and efficient storage management.
If you're looking for a feature that doesn't exist in Fluss, you're probably not alone. Others likely have similar needs. Please open a GitHub Issue describing the feature you'd like to see, why you need it, and how it should work.
When creating your feature request, start by clearly documenting your requirements and avoid jumping straight to implementation details. For substantial features or architectural changes that need broader community input, consider submitting a Fluss Improvement Proposal (FIP). FIPs offer a formal process to propose, discuss, and document significant project enhancements.