elguardian commented on code in PR #1905: URL: https://github.com/apache/incubator-kie-kogito-apps/pull/1905#discussion_r1396836828
########## data-audit/README.md: ########## @@ -0,0 +1,96 @@ +### Data Audit subsystem + +This is the implementation of the Kogito Audit subystem. The subsystem allows to store the events from issued by +- process engine +- user task +- job service + +Main features are: + +- runs as colocated services with quarkus and springboot +- module to write your own subsystem +- graphql modules to query data +- extension points to develop new storage easily +- extension points to develop new queries extending graphql definitions + +## Design of the Data Audit + +The system contains several modules and common modules to redistribute responsabilities. + + + +Data Audit Common: Provides the common framework to create implementations. +Data Audit «Quarkus»: Provides the wiring to use Data Audit with Quarkus as colocated service (deployment) +Data Audit «SpringBoot»: Provides the wiring to use Data Audit with SpringBoot as colocated service (deployment) + +Now we have and implementation examples + + +Data Audit JPA Common: Provides the common exension not depending on the runtime +Data Audit JPA «Quarkus»: Provides the wiring between the specific implementation and Quarkus System +Data Audit JPA «SpringBoot»: Provides the wiring between the specific implementation and Springboot colocated system + + +## Queries + +The way to retrieve information from the data audit is to use GraphQL. This way we can abstract how the information is retrieved and allow different needs depending on the user. + +## JPA implementation + +The jpa implementation allows you to store those events to be stored in a database. + +## Extension Points + +There are two different extensions. Those who belong to the runtime to wire things and those which does not depends on the runtime + +Extension points depending on the runtime is: +org.kie.kogito.app.audit.spi.DataAuditContextFactory: this allos to create context needed by a particular implementation Review Comment: done -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
