What is the best practice for adding an entry to the audit log programmatically?

Using the Auditor class to capture AuditEvents is the best practice for adding an entry to the audit log programmatically because it provides a standardized and consistent way to log audit events within the application. The Auditor class is designed to handle the intricacies of logging, such as ensuring that the audit entries are formatted correctly, managing the underlying storage of the logs, and adhering to the security and compliance requirements associated with audit trails.

By utilizing the Auditor class, you can ensure that your audit logs maintain integrity and accuracy, which is essential for tracking user actions and understanding system changes over time. This approach abstracts the complexity involved in direct database manipulation, offering a higher level of assurance that the logs will capture all necessary information and that they conform to the logging framework used by SailPoint.

This method also facilitates better maintenance and scalability of the application since it adheres to the best practices and design patterns used in the SailPoint framework, making it easier for future developers to understand and extend the logging functionality if necessary.