Description
To improve the performance and scalability of audit log retrieval, we are officially deprecating get_audit_report().
While get_audit_report() has served as the primary method for retrieving audit logs, the increasingly large volume of audit data has made the structured overhead of this function less efficient. The get_audit_csv_report() function is highly optimized for large datasets and provides a more performant, streamlined experience for users.
Rationale for users:
- Efficiency:
get_audit_csv_report() handles large-scale data transfers more reliably.
- Consistency: CSV format is better suited for the tabular nature of audit logs, reducing parsing overhead.
- Future-proofing: New features and filters will be prioritized for the CSV-based reporting tool.
Deprecation Strategy
We will follow a standard deprecation cycle to give users time to migrate their scripts:
- Phase 1 (Current): Add a deprecation warning to
get_audit_report(). The function will still work but will advise users to switch to get_audit_csv_report().
- Phase 2 (Next Major Release): Move the function to "defunct" status (it will stop working and return an error pointing to the replacement).
- Phase 3: Total removal from the namespace.
Description
To improve the performance and scalability of audit log retrieval, we are officially deprecating
get_audit_report().While
get_audit_report()has served as the primary method for retrieving audit logs, the increasingly large volume of audit data has made the structured overhead of this function less efficient. Theget_audit_csv_report()function is highly optimized for large datasets and provides a more performant, streamlined experience for users.Rationale for users:
get_audit_csv_report()handles large-scale data transfers more reliably.Deprecation Strategy
We will follow a standard deprecation cycle to give users time to migrate their scripts:
get_audit_report(). The function will still work but will advise users to switch toget_audit_csv_report().