https://github.com/spt-development/spt-development-audit-spring-boot

Library for integrating spt-development/spt-development-audit-spring into a Spring Boot application.
https://github.com/spt-development/spt-development-audit-spring-boot

auditing spring-boot spring-boot-autoconfiguration spring-boot-starter

Last synced: about 2 months ago
JSON representation

Library for integrating spt-development/spt-development-audit-spring into a Spring Boot application.

• Host: GitHub
• URL: https://github.com/spt-development/spt-development-audit-spring-boot
• Owner: spt-development
• License: apache-2.0
• Created: 2021-02-23T10:05:08.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2024-09-15T12:32:48.000Z (3 months ago)
• Last Synced: 2024-09-16T13:15:51.887Z (3 months ago)
• Topics: auditing, spring-boot, spring-boot-autoconfiguration, spring-boot-starter
• Language: Java
• Homepage: https://github.com/spt-development/spt-development-audit-spring-boot
• Size: 175 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
````

  ____  ____ _____   ____                 _                                  _   

 / ___||  _ \_   _| |  _ \  _____   _____| | ___  _ __  _ __ ___   ___ _ __ | |_ 

 \___ \| |_) || |   | | | |/ _ \ \ / / _ \ |/ _ \| '_ \| '_ ` _ \ / _ \ '_ \| __|

  ___) |  __/ | |   | |_| |  __/\ V /  __/ | (_) | |_) | | | | | |  __/ | | | |_ 

 |____/|_|    |_|   |____/ \___| \_/ \___|_|\___/| .__/|_| |_| |_|\___|_| |_|\__|

                                                 |_|                                           

 audit-spring-boot---------------------------------------------------------------

````

[![build_status](https://github.com/spt-development/spt-development-audit-spring-boot/actions/workflows/build.yml/badge.svg)](https://github.com/spt-development/spt-development-audit-spring-boot/actions)

Library for integrating 

[spt-development/spt-development-audit-spring](https://github.com/spt-development/spt-development-audit-spring) 

into a Spring Boot application.

Usage

=====

Add the Spring Boot starter to your Spring Boot project pom.

```xml

    com.spt-development

    spt-development-audit-spring-boot-starter

    1.0.0

    runtime

```

To configure the `JmsAuditEventWriter` rather than the default `Slf4jAuditEventWriter` set the `spt.audit.jms.destination`

property to the name of your JMS audit event queue/topic and ensure a `JmsTemplate` bean is created.

The auto-configuration, relies on build information from the `org.springframework.boot.info.BuildProperties` bean. To

make this bean available, add the `build-info` execution to the `spring-boot-maven-plugin` configuration.

```xml

    org.springframework.boot

    spring-boot-maven-plugin

    

        

            build-info

            

                build-info

            

        

    

```

Additionally, you should set the `spring.application.name` property to change the name of the application (that is 

added to the audit events) from the default "Spring Boot".

Building locally

================

To build the library, run the following maven command:

```shell

$ ./mvnw clean install

```

Release

=======

To build a release and upload to Maven Central push to `main`.