| commit | f7867e83d61aeb5f6a7d03a95dc3ca4aebafa84b | [log] [tgz] |
|---|---|---|
| author | Ralph Goers <rgoers@nextiva.com> | Sat Sep 02 23:36:02 2017 -0700 |
| committer | Ralph Goers <rgoers@nextiva.com> | Sat Sep 02 23:36:02 2017 -0700 |
| tree | a74695e7efb7611ccc2fde8b62124ebe800b32f3 | |
| parent | 3ba2b59630e871ddd0bff2d3abc35c856a7620f5 [diff] |
Add the first README
Log4j-Audit provides a framework for defining audit events and then logging them using Log4j. The framework focuses on defining the events and providing an easy mechanism for applications to log them, allowing products to provide consistency and validity to the events that are logged. It does not focus on how the log events are written to a data store. Log4j itself provides many options for that.
The expected process is that business analysts or product managers will be managing the catalog, defining the events and attributes so that consumers of the events will have a consistent experience. For example, instead of one event using an attribute with a name of “custAddr” and another using a name of “customerAddress”, both would use the same name for attributes that have the same meaning.
Once the catalog is modified in the web application it is saved as JSON to a git repository. It is expected that a continuous integration system would notice the change and start a build of that project. The build would use the Log4j Audit Maven Plugin to generate Java interfaces that Java developers would use to implement the audit logging within the application. Non-Java applications would call the Audit Service by sending an appropriate Data Transfer Object in JSON form and the Audit Service would perform the same validation that logging via the Java Interface would.
The Log4j Audit module contains the Log4j Audit API that Java application leverage to perform audit logging, the Log4j Audit Maven Plugin that generates Java Interfaces from the catalog, and the Audit Service that non-Java applications interact with to perform audit logging. The Audit service will also provide access to define dynamic catalog entries for systems that allow new custom objects and attributes to be created while the application is executing and need to audit when actions are taken against these objects.
The Log4j Catalog module contains the API for working with the catalog, a module for persisting the catalog using the Java Persistence Architecture (JPA), a module for reading and writing the JSON version of the catalog to a remote GIT repository, and a module that provides a web application that can edit the various components of the catalog.