Alfresco Community Edition provides the ability
to audit activity. The auditing system is disabled by default, as it has the potential to
impact performance, but the auditing system is highly configurable, so that you only need
generate data for those events of particular interest.
- Overview Auditing in Alfresco Community Edition is highly configurable. There are a number of components that interact with each other so that only the specific events that need to be audited are logged. This reduces the performance impact should auditing be required. The key components of the auditing system are described here.
- Key tools and files Some initial information on key tools and file to get you started.
- How to enable auditing Generation of audit data is disabled by default as it can potentially impact the performance of Alfresco Community Edition. To enable auditing, configuration must be added to the Alfresco Community Edition global properties file.
- How to check audit status It is useful to check the current audit status of an Alfresco Community Edition installation. You can do this via the AuditService Java API, but this can also be done via the REST API. The REST API can be accessed via web scripts, or simply using a command line client such as Curl.
- How to use the auditing sample files Auditing sample files are distributed in the ./tomcat/shared/classes/alfresco/extension/audit directory. You can enable them in order to explore auditing.
- Using the auditing REST API You can use the REST API to control auditing and also run queries against the audit data for specific applications. It is also possible to clear auditing data using the API.
- Default auditing global properties When Alfresco Community Edition is installed it has a set of default auditing properties you should be aware of.
- Audit filters Audit data can be controlled by using audit filters. Audit filters provide a fine grain of control over which events are audited.
- Audit configuration The most common reason to customize the audit configuration is if there is a need to extract individual property or aspect values that have special meaning to a particular Alfresco Community Edition installation.
- Auditing Tutorials The various concepts described in this documentation can be tried out in these hands-on tutorials.
Parent topic: Administering