https://github.com/musabbozkurt/inventory-management-service

PostgreSQL, Zipkin, Prometheus, Grafana, Redis, Kafka and New Relic Integrations with Spring Boot 3, Java 21, and Docker. Integration Tests with Testcontainers for Controller. Unit Tests for Service, and Mapper with Junit 5, and Mockito
https://github.com/musabbozkurt/inventory-management-service

docker-compose flyway grafana java-21 jjwt kafka micrometer newrelic postgresql prometheus redis spring-boot-3 spring-cloud spring-security springdoc-openapi testcontainers zipkin

Last synced: 3 months ago
JSON representation

PostgreSQL, Zipkin, Prometheus, Grafana, Redis, Kafka and New Relic Integrations with Spring Boot 3, Java 21, and Docker. Integration Tests with Testcontainers for Controller. Unit Tests for Service, and Mapper with Junit 5, and Mockito

• Host: GitHub
• URL: https://github.com/musabbozkurt/inventory-management-service
• Owner: musabbozkurt
• Created: 2024-07-12T13:42:51.000Z (7 months ago)
• Default Branch: master
• Last Pushed: 2024-08-29T21:35:37.000Z (5 months ago)
• Last Synced: 2024-09-28T15:40:13.663Z (4 months ago)
• Topics: docker-compose, flyway, grafana, java-21, jjwt, kafka, micrometer, newrelic, postgresql, prometheus, redis, spring-boot-3, spring-cloud, spring-security, springdoc-openapi, testcontainers, zipkin
• Language: Java
• Homepage:
• Size: 151 KB
• Stars: 7
• Watchers: 1
• Forks: 3
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
### Prerequisites

* `Java 21` should be installed --> `export JAVA_HOME=$(/usr/libexec/java_home -v 21)`

* `Docker` should be installed

* `Maven` should be installed

* `pgAdmin`/`DBeaver` can be installed (Optional)

* `New Relic` is disabled by default. Properties can be set (Optional)

    * If there is a `New Relic` account, log in to [New Relic](https://login.newrelic.com/login)

        1. Generate `api-key` and replace the `NEW_RELIC_LICENSE_KEY` value with yours in the [.env](.env) file

        2. Replace the `NEW_RELIC_ENDPOINT` value with yours in the [.env](.env) file

        3. In the [.env](.env) file, if `api-key` and `endpoint` are present with the correct values,

           `NEW_RELIC_AGENT_ENABLED` can be `true` and `NEW_RELIC_INFRA_AGENT_REPLICAS` can be greater than zero(0)

-----

### How to start the application

1. Run `mvn clean install` or `mvn clean package`

2. Run `mvn spring-boot:run` or `./mvnw spring-boot:run`

    - Run [./scripts/run.sh](scripts%2Frun.sh) to start the application with `New Relic Java agent` (Optional)

    - `docker-compose --profile start_application up -d --build` can be run to create and run a Docker image of the

      application with `New Relic Java agent` (Optional)

-----

### How to test the application

* Run `mvn test` or `mvn clean install` or `mvn clean package` command to run all the tests

* Swagger Url: http://localhost:8080/swagger-ui.html

* Test User to Get JWT Token via `/auth/signin` API:

    * `username: admin_user`

    * `password: test1234`

    * Copy the generated token and paste it to the following popup in `Swagger`

        * ![img.png](img.png)

* Actuator Url: http://localhost:8080/actuator

* Metric Url: http://localhost:8080/actuator/metrics

-----

### `docker-compose` contains the followings

* PostgreSQL DB connection details

    * `POSTGRES_USER: postgres`

    * `POSTGRES_PASSWORD: postgres`

    * `Port: 5432`

* Zipkin: http://localhost:9411/

* Prometheus: http://localhost:9090/graph

* Grafana: http://localhost:3000/

    * `Email or username: admin`

    * `Password: admin`

    * Add datasource

        * Select Prometheus

        * Prometheus Url: http://prometheus:9090/

        * Save & test

* Kafka-UI: http://localhost:9091/

-----

### References

* https://github.com/newrelic/micrometer-registry-newrelic?tab=readme-ov-file#archival-notice

* https://docs.micrometer.io/micrometer/reference/implementations/new-relic.html

-----