sscs-hearings-api

Building and deploying the application

Building the application

The project uses Gradle as a build tool. It already contains ./gradlew wrapper script, so there's no need to install gradle.

To build the project execute the following command:

  ./gradlew build

Running the application

Create the image of the application by executing the following command:

  ./gradlew assemble

Create docker image:

  docker-compose build

Run the distribution (created in build/install/sscs-hearings-api directory) by executing the following command:

  docker-compose up

This will start the API container exposing the application's port (set to 8083 in this template app).

In order to test if the application is up, you can call its health endpoint:

  curl http://localhost:8083/health

You should get a response similar to this:

  {"status":"UP","diskSpace":{"status":"UP","total":249644974080,"free":137188298752,"threshold":10485760}}

Alternative script to run application

To skip all the setting up and building, just execute the following command:

./bin/run-in-docker.sh

For more information:

./bin/run-in-docker.sh -h

Script includes bare minimum environment variables necessary to start api instance. Whenever any variable is changed or any other script regarding docker image/container build, the suggested way to ensure all is cleaned up properly is by this command:

docker-compose rm

It clears stopped containers correctly. Might consider removing clutter of images too, especially the ones fiddled with:

docker images

docker image rm <image-id>

There is no need to remove postgres and java or similar core images.

AppInsights Events

You will need to set the environment variable for the HMC failure messages to be sent as events to Azure AppInsights.

The env var should look similar to below and will need to be grabbed from Azure or another developer.

APPLICATIONINSIGHTS_CONNECTION_STRING=InstrumentationKey\=xxx-xxx-xxx\;IngestionEndpoint\=xxx-xxx-xxx/

Other

Hystrix offers much more than Circuit Breaker pattern implementation or command monitoring. Here are some other functionalities it provides:

• Separate, per-dependency thread pools
• Semaphores, which you can use to limit the number of concurrent calls to any given dependency
• Request caching, allowing different code paths to execute Hystrix Commands without worrying about duplicating work

License

This project is licensed under the MIT License - see the LICENSE file for details