search

apache / incubator-streampark

Make stream processing easier! Easy-to-use streaming application development framework and operation platform.
https://streampark.apache.org/
Apache License 2.0
3.88k stars 1.01k forks source link

[Feature] Add tag modified versions and change person logs #3996

Open skimo-dy opened 2 months ago

skimo-dy commented 2 months ago

Search before asking

Description

Currently, StreamPark lacks a direct and efficient way to track changes made to specific versions of resources or configurations, as well as identify who made those changes. This can lead to difficulties in debugging, auditing, and maintaining a clear history of modifications over time. To enhance the platform's usability, traceability, and accountability, we propose the implementation of two key features:  Version Tagging: Allow users to tag specific versions of resources (e.g., streams, workflows, configurations) with a descriptive label or version number. This will enable easy identification and retrieval of specific versions, facilitating rollbacks or comparisons between versions. Change Log with User Attribution: Maintain a detailed record of all changes made to resources, including the date and time of the change, the nature of the change (e.g., update, deletion, creation), and most importantly, the identity of the user who made the change. This change log should be accessible directly from the resource's interface, providing a clear audit trail and fostering accountability. Benefits:  Improved Debugging: By being able to quickly locate and compare versions, developers and administrators can more easily identify the root cause of issues. Enhanced Auditing: The change log with user attribution provides a solid foundation for compliance and security audits, allowing organizations to track who made what changes and when. Better Collaboration: Knowing who made what changes can facilitate communication and collaboration between team members, reducing confusion and misunderstandings. Implementation Considerations:  Ensure that the implementation is scalable and performant, especially for large-scale deployments with high volumes of changes. Provide flexible configuration options to allow administrators to customize the level of detail captured in the change log. Consider integrating with existing user management and authentication systems to accurately attribute changes to specific users. Conclusion: The addition of version tagging and a comprehensive change log with user attribution would significantly enhance StreamPark's capabilities, making it an even more powerful and user-friendly platform for stream processing and workflow management.

Usage Scenario

Scenario 1: Rapid Fault Diagnosis and Recovery In a fast-paced financial tech company, StreamPark processes real-time transaction data. When an issue arises, developers use version tagging to quickly revert to a stable version, compare changes, and identify the root cause. The change log with user attribution helps them reach out to the last modifier for insights.  Scenario 2: Compliance Auditing and Regulatory Reporting To comply with strict financial regulations, the company needs to report on data processing changes. StreamPark's change log automatically records modifications, including who made them. This simplifies audits, ensures accuracy, and facilitates regulatory reporting.  Scenario 3: Team Collaboration and Knowledge Transfer As the team grows, new members need to understand existing StreamPark configurations. Version tagging and the change log provide a historical record, making it easier for new team members to grasp project evolution and collaborate effectively with their peers. 

Related issues

Currently, StreamPark lacks a direct and efficient way to track changes made to specific versions of resources or configurations, as well as identify who made those changes. This can lead to difficulties in debugging, auditing, and maintaining a clear history of modifications over time.

Are you willing to submit a PR?

Code of Conduct

wangyp501 commented 2 months ago

good

wolfboys commented 2 months ago

Sounds good to me, The community currently has no plans for this. If you intend to contribute to this feature, we would gladly accept it.

skimo-dy commented 2 months ago

Sounds good to me, The community currently has no plans for this. If you intend to contribute to this feature, we would gladly accept it.

That's great to hear! I'm happy to contribute to this feature.