# Audit Manager Developers Guide ## Overview [Audit-Manager](https://docs.mosip.io/1.2.0/modules/commons) module provides audit related functionalities. Below is a list of tools required in Audit: 1. JDK 11 2. Any IDE (like Eclipse, IntelliJ IDEA) 3. Apache Maven (zip folder) 4. PostgreSQL 5. Any DB client (like DBeaver, pgAdmin) 6. Postman (any HTTP Client) 7. Git 8. Any Editor (like Vscode, Notepad++ etc optional) 9. lombok.jar (jar file) 10. settings.xml (document) ### Software setup 1\. Download [lombok.jar](https://projectlombok.org/download) and [settings.xml](https://github.com/mosip/documentation/tree/1.2.0/docs/_files/commons/settings.xml). 2\. Unzip Apache Maven and move `settings.xml` to "conf" folder `\conf`. 3\. Install Eclipse, open the `lombok.jar` file and then click `Install/Update`. ![](https://1701354953-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MKdauHHDPmc5uZiXAWv-3164950280%2Fuploads%2Fgit-blob-3250159d31f0da893a56ac8df5d41742e77bd893%2Flombok-configuration.png?alt=media) 4\. Check the Eclipse installation folder to see if the `lombok.jar` is added. 5\. Configure the JDK (Standard VM) with your Eclipse by traversing through `Preferences → Java → Installed JREs`. ![](https://1701354953-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MKdauHHDPmc5uZiXAWv-3164950280%2Fuploads%2Fgit-blob-97bc2ee165f2817896c36a5c6f6b31c31d5642d9%2Finstalled-jre.png?alt=media) ### Source code setup For the code setup, clone the repository and follow the guidelines mentioned in the [Code Contributions](https://docs.mosip.io/1.2.0/community/code-contributions). ### Importing and building 1. Open the project folder where `pom.xml` is present. 2. Open command prompt from the same folder. 3. Run the command `mvn clean install -Dgpg.skip=true -DskipTests=true` to build the project. 4. After building, open Eclipse and select `Import Projects → Maven → Existing Maven Projects → Next → Browse to project directory → Finish`. 5. After successful importing of project, update the project by right-click on `Project → Maven → Update Project`. ![](https://1701354953-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MKdauHHDPmc5uZiXAWv-3164950280%2Fuploads%2Fgit-blob-cdfe9b8220ce8bd52bc56858c0ae757b802488e9%2Fimport-project.png?alt=media) ## Environment setup 1\. Download [Auth adapter](https://oss.sonatype.org/#nexus-search;gav~~kernel-auth-adapter~1.2.0-SNAPSHOT~~) and add to project `Libraries → Classpath → Add External JARs → Select Downloaded JAR → Add → Apply and Close`. ![](https://1701354953-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MKdauHHDPmc5uZiXAWv-3164950280%2Fuploads%2Fgit-blob-532de58ab0c7f6104c0cfe397886de1672c0a94b%2Fadd-external-library.png?alt=media) 2\. Clone [mosip-config repository](https://github.com/mosip/mosip-config). 3\. Refer [Audit-DB-deploy](https://github.com/mosip/audit-manager/tree/release-1.2.0/db_scripts/README.md) to deploy local DB. 4\. Audit uses two property files, `kernel-default` and `application-default`, configure them accordingly. For instance, * Update `mosip.kernel.auditmanager-service-logs-location` property to update location of log files. * Secrets can be encrypted using [config server](https://cloud.spring.io/spring-cloud-config/reference/html/#_encryption_and_decryption). * Update URL's in property files.(It can be either pointed to any remotely or locally deployed services) 5\. Download [kernel-config-server.jar](https://oss.sonatype.org/#nexus-search;gav~~kernel-config-server~1.2.0-SNAPSHOT~~). For Windows, download [config-server-start.bat](https://github.com/nayakrounak/documentation/blob/1.2.0/docs/_files/commons/config-server-start.bat), linux users can run `java -jar -Dspring.profiles.active=native -Dspring.cloud.config.server.native.search-locations=file:{mosip-config-mt_folder_path}/config -Dspring.cloud.config.server.accept-empty=true -Dspring.cloud.config.server.git.force-pull=false -Dspring.cloud.config.server.git.cloneOnStart=false -Dspring.cloud.config.server.git.refreshRate=0 {jarName}` . 6\. Run the server by opening the `config-server-start.bat` file. ![](https://1701354953-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MKdauHHDPmc5uZiXAWv-3164950280%2Fuploads%2Fgit-blob-834c40ade1c9f9aad606625a6d0acc2e6ca20dbe%2Frun-server.png?alt=media) 7\. To verify the config-server, hit the below URL: `http://localhost:51000/config/{spring.profiles.active}/{spring.cloud.config.name}/{spring.cloud.config.label}` for instance `http://localhost:51000/config/kernel/env/master`. ## Initialization and utilization of module 1. Audit REST service consist of `bootstrap.properties` file in `src/main/resources`. 2. Below properties needed to be modified in order to connect to the config server: ``` spring.cloud.config.uri= spring.cloud.config.label= spring.profiles.active=default ``` 3. Services can be run using `Run As -> Spring Boot App/Java Application`. 4. For API documentation, refer [here](https://docs.mosip.io/1.2.0/api). 5. The API's can be tried with the help of **Swagger-UI** and **Postman**. 6. Swagger-UI of service can be accessed from `(https/http)://(/:)//swagger-ui/index.html?configUrl=/v3/api-docs/swagger-config` for instance `https://dev2.mosip.net/v1/auditmanager/swagger-ui/index.html?configUrl=/v1/auditmanager/v3/api-docs/swagger-config`. 7. The API's can be tried using postman by copying CURL command below, updating host and importing in Postman. ``` curl -X 'POST' \ 'https:///v1/auditmanager/audits' \ -H 'accept: application/json' \ -H 'Content-Type: application/json' \ -d '{ "id": "string", "version": "string", "requesttime": "2022-04-20T12:23:59.300Z", "metadata": {}, "request": { "eventId": "string", "eventName": "string", "eventType": "string", "actionTimeStamp": "2022-04-20T12:23:59.300Z", "hostName": "string", "hostIp": "string", "applicationId": "string", "applicationName": "string", "sessionUserId": "string", "sessionUserName": "string", "id": "string", "idType": "string", "createdBy": "string", "moduleName": "string", "moduleId": "string", "description": "string" } }' ``` ![](https://1701354953-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MKdauHHDPmc5uZiXAWv-3164950280%2Fuploads%2Fgit-blob-ef8dc403f9e5fdf8f630dce5eca884c4e35ee36d%2Fpostman-import-curl.png?alt=media)