/fighting-animals

Fighting Animals Demo

Primary LanguageJava

Animal vs. Animal

Description

This project provides a simple structure to demonstrate Observability (especially distributed traces).

There are several branches:

  • main - no Observability
  • micrometer_only - Micrometer Metrics only
  • manual_tracing - OTel Tracing using manual spans
  • auto_tracing_only - Use of the OTel Java agent to trace automatically
  • logging_only -
  • auto_otel -

The system of microservices simulates a battle between two animals chosen from several different clades of animal. Call GET /battle to get a battle that looks like this:

Output:

{ "good": , "evil": }

Each low-level service contains a simple GET /getAnimal route, and top-level service calls one of the low-level services application's GET /getAnimal route for each side (chosen randomly).

The routes are as follows:

Building the project

To build the project, use:

mvn clean package

This will generate a shaded JAR that can be picked up by the following steps.

The project is deployed using Docker. Each separate subcomponent needs a separate container, they are built like this:

docker build -t animals_demo -f src/main/docker/animal/Dockerfile target/
docker build -t feline_demo -f src/main/docker/feline/Dockerfile target/
docker build -t fish_demo -f src/main/docker/fish/Dockerfile target/
docker build -t mammal_demo -f src/main/docker/mammal/Dockerfile target/
docker build -t mustelid_demo -f src/main/docker/mustelid/Dockerfile target/

That is, the tag name should match the contents of docker-compose.yml

Running the project

In the deploy directory are a docker-compose YAML file and a collector config.

docker-compose up

On this branch, no Observability components are deployed.

Known Issues