KryStatusMonitorProject

The project is built using Maven. The services which are to be monitored need to have actuator dependency. KryStatusMonitorProject calls "/actuator/health" endpoint for each of these services to check their status.

Run docker-compose up -d to setup MongoDB container in the docker.

To add the actuator to a Maven-based project, add the following ‘Starter’ dependency:

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-actuator</artifactId>
    </dependency>
</dependencies>

For Gradle, use the following declaration:

dependencies {
    implementation 'org.springframework.boot:spring-boot-starter-actuator'
}

Database configuration

Database Used :- MongoDB (no user id or password is needed)

Database host=localhost

Database port=27017

Database name=KryServiceStatus

Steps to run the project

1. Port for the application = 9090

2. To run the project either import project in your preffered IDE or run following commands :-

   mvn install / mvn clean install
   
   mvn spring-boot:run 
   

REST Endpoints for testing

"id" is integer value and "name" is string value.

1. GET http://localhost:9090/statusMonitorService/healthreports/{id} :- "id" is user id for which you need to see the status of all the added services.

e.g. Request:-

curl -X GET \
  http://localhost:9090/statusMonitorService/healthreport/1 \

e.g. Response:-

[
    {
        "url": "http://localhost:8080",
        "name": "service1",
        "creationTime": "2021-12-11T12:33:40.652Z",
        "healthList": [
            {
                "status": "UP",
                "time": "2021-12-11T11:52:47.488Z"
            },
            {
                "status": "UP",
                "time": "2021-12-11T12:28:09.345Z"
            }
        ]
    },
    {
        "url": "http://localhost:8081",
        "name": "service2",
        "creationTime": "2021-12-11T12:33:40.664Z",
        "healthList": [
            {
                "status": "DOWN",
                "time": "2021-12-11T11:52:53.981Z"
            },
            {
                "status": "DOWN",
                "time": "2021-12-11T12:28:09.347Z"
            }
        ]
    }
]

2. POST http://localhost:9090/statusMonitorService/addservice/{id} :- "id" is the user id for which you need to add a service for monitoring.

e.g. Request:-

curl -X POST \
  http://localhost:9090/statusMonitorService/addservice/1 \
  -H 'content-type: application/json' \
  -d '{ "url": "http://localhost:8080",  "name": "service"}'

e.g. body:-

{
    "url": "http://localhost:8080",
    "name": "service"
}

3. GET http://localhost:9090/statusMonitorService/healthreport/{id}/{name} :- "id" is user id and "name" is the service name for which you need to check the status.

e.g. Request:-

curl -X GET \
  http://localhost:9090/statusMonitorService/healthreport/1/service \

e.g. Response:-

  {
       "url": "http://localhost:8080",
       "name": "service1",
       "creationTime": "2021-12-11T12:33:40.652Z",
       "healthList": [
           {
               "status": "UP",
               "time": "2021-12-11T11:52:47.488Z"
           },
           {
               "status": "UP",
               "time": "2021-12-11T12:28:09.345Z"
           }
       ]
   }

4. DELETE http://localhost:9090/statusMonitorService/deleteservice/{id}/{name} :- "id" is user id and "name" is the service name which you want to delete for the provided user id.

e.g. Request:-

curl -X DELETE \
  http://localhost:9090/statusMonitorService/healthreport/1/service \

5. The application updates the status for all the services added by all the users for every 5000 milliseconds. This value can be updated in StatusMonitorScheduler.java.