Skip to content

Latest commit

 

History

History
296 lines (227 loc) · 13.2 KB

readme.md

File metadata and controls

296 lines (227 loc) · 13.2 KB

NOTE: This project was taken from https://github.com/spring-projects/spring-petclinic, and was modified to include Chaos Monkey.

Chaos Monkey for Spring Boot

Setup

Include Chaos Monkey in the dependencies in your pom.xml.

      <dependency>
          <groupId>de.codecentric</groupId>
          <artifactId>chaos-monkey-spring-boot</artifactId>
          <version>2.0.2</version>
      </dependency>

Turn on the Chaos Monkey endpoints in your application properties.

 management.endpoint.chaosmonkey.enabled=true
 management.endpoint.chaosmonkeyjmx.enabled=true

 management.endpoints.web.exposure.include=*

 management.endpoints.web.exposure.include=health,info,chaosmonkey

Chaos Monkey for Spring Boot uses watchers to "assault" various types of classes. It can be used to assault classes annotated with @Service, @RestController, @Controller, @Repository, and @Component. You will have to indicate which watchers you would like to use prior to compilation and runtime.

Include the following in either your application.properties or an application.yml. It is encouraged to create a separate application-chaos-monkey.yml. Be sure to indicate which watchers you would like with "true" or "false":

YOU CANNOT CHANGE THIS DURING RUNTIME. If no watchers are enabled, no assaults will be performed.

application.properties

chaos.monkey.watcher.component=false
chaos.monkey.watcher.controller=false
chaos.monkey.watcher.restController=true
chaos.monkey.watcher.service=true
chaos.monkey.watcher.repository=false

application.yml

chaos:
  monkey:
    enabled: true
    watcher:
      component: false
      controller: false
      repository: false
      rest-controller: true
      service: true

Running your application with Chaos Monkey enabled

Make sure you are in the project directory. Run:

./mvnw package
java -jar <YOURAPP>.jar --spring.profiles.active=chaos-monkey

Available Requests

We have set up our properties to allow us to send Chaos Monkey requests during runtime.

The first request you will want to send is one to verify that Chaos Monkey is enabled. All requests are listed below. You will also want to send a POST request to "/chaosmonkey/assaults" with the assault configuration desired. Further information regarding Assaults is in the next section.

endpoint Description Method
/chaosmonkey Get the running Chaos Monkey configuration GET
/chaosmonkey/status Is Chaos Monkey enabled or disabled? GET
/chaosmonkey/enable Enable Chaos Monkey POST
/chaosmonkey/disable Disable Chaos Monkey POST
/chaosmonkey/watcher Get the running Watcher configuration. NOTE: Watcher cannot be changed at runtime, they are Spring AOP components that have to be created when the application starts. GET
/chaosmonkey/assaults Get the running Assaults configuration GET
/chaosmonkey/assaults Change the Assaults configuration POST

See https://codecentric.github.io/chaos-monkey-spring-boot/2.0.2/#_examples for examples of request responses and request bodies.

Assaults

The following is an example of an assault configuration.

The important properties to note are:

Property Description
level How frequent the "assaults" are. level 1 = each request is attacked, level 5 = every 5th request is attacked, level 10 = every 10th request is attacked. Available values are 1 - 10
latencyRangeStart minimum latency during assault
latencyRangeEnd maximum latency during assault
latencyActive Are latency assaults on or off
exceptionsActive Are exception assaults on or off
exception the exception type and message
killApplicationActive Are assaults that will kill the application on or off
watchedCustomServices You may specify a list of particular methods/services you want Chaos Monkey to assault. If you provide an empty list ([]) or null, all requests (satisfying the watcher configuration and assault level) will be assaulted 
{
    "level": 5,
    "latencyRangeStart": 1000,
    "latencyRangeEnd": 3000,
    "latencyActive": true,
    "exceptionsActive": false,
    "exception": {
        "type": null,
        "arguments": null
    },
    "killApplicationActive": false,
    "watchedCustomServices": null,
    "frozen": false,
    "targetSource": {
        "target": {
            "level": 5,
            "latencyRangeStart": 1000,
            "latencyRangeEnd": 3000,
            "latencyActive": true,
            "exceptionsActive": false,
            "exception": {
                  "type": "java.lang.RuntimeException",
                  "arguments": [{
            	      "className": "java.lang.String",
            	      "value": "You have encountered a runtime exception"}]
            },
            "killApplicationActive": false,
            "watchedCustomServices": null
        },
        "static": true,
        "targetClass": "de.codecentric.spring.boot.chaos.monkey.configuration.AssaultProperties"
    },
    "targetClass": "de.codecentric.spring.boot.chaos.monkey.configuration.AssaultProperties",
    "proxiedInterfaces": [],
    "advisors": [
        {
            "order": 2147483647,
            "advice": {},
            "pointcut": {
                "classFilter": {},
                "methodMatcher": {
                    "runtime": false
                }
            },
            "perInstance": true
        }
    ],
    "proxyTargetClass": true,
    "exposeProxy": false,
    "preFiltered": false
}

Spring PetClinic Sample Application Build Status

Deploy this sample application to Pivotal Web Services: Push

Understanding the Spring Petclinic application with a few diagrams

See the presentation here

Running petclinic locally

Petclinic is a Spring Boot application built using Maven. You can build a jar file and run it from the command line:

git clone https://github.com/spring-projects/spring-petclinic.git
cd spring-petclinic
./mvnw package
java -jar target/*.jar

You can then access petclinic here: http://localhost:8080/

petclinic-screenshot

Or you can run it from Maven directly using the Spring Boot Maven plugin. If you do this it will pick up changes that you make in the project immediately (changes to Java source files require a compile as well - most people use an IDE for this):

./mvnw spring-boot:run

In case you find a bug/suggested improvement for Spring Petclinic

Our issue tracker is available here: https://github.com/spring-projects/spring-petclinic/issues

Database configuration

In its default configuration, Petclinic uses an in-memory database (HSQLDB) which gets populated at startup with data. A similar setup is provided for MySql in case a persistent database configuration is needed. Note that whenever the database type is changed, the app needs to be run with a different profile: spring.profiles.active=mysql for MySql.

You could start MySql locally with whatever installer works for your OS, or with docker:

docker run -e MYSQL_ROOT_PASSWORD=petclinic -e MYSQL_DATABASE=petclinic -p 3306:3306 mysql:5.7.8

Further documentation is provided here.

Working with Petclinic in your IDE

Prerequisites

The following items should be installed in your system:

Steps:

  1. On the command line
git clone https://github.com/spring-projects/spring-petclinic.git
  1. Inside Eclipse or STS
File -> Import -> Maven -> Existing Maven project

Then either build on the command line ./mvnw generate-resources or using the Eclipse launcher (right click on project and Run As -> Maven install) to generate the css. Run the application main method by right clicking on it and choosing Run As -> Java Application.

  1. Inside IntelliJ IDEA

In the main menu, choose File -> Open and select the Petclinic pom.xml. Click on the Open button.

CSS files are generated from the Maven build. You can either build them on the command line ./mvnw generate-resources or right click on the spring-petclinic project then Maven -> Generates sources and Update Folders.

A run configuration named PetClinicApplication should have been created for you if you're using a recent Ultimate version. Otherwise, run the application by right clicking on the PetClinicApplication main class and choosing Run 'PetClinicApplication'.

  1. Navigate to Petclinic

Visit http://localhost:8080 in your browser.

Looking for something in particular?

Spring Boot Configuration Class or Java property files
The Main Class PetClinicApplication
Properties Files application.properties
Caching CacheConfiguration

Interesting Spring Petclinic branches and forks

The Spring Petclinic master branch in the main spring-projects GitHub org is the "canonical" implementation, currently based on Spring Boot and Thymeleaf. There are quite a few forks in a special GitHub org spring-petclinic. If you have a special interest in a different technology stack that could be used to implement the Pet Clinic then please join the community there.

Interaction with other open source projects

One of the best parts about working on the Spring Petclinic application is that we have the opportunity to work in direct contact with many Open Source projects. We found some bugs/suggested improvements on various topics such as Spring, Spring Data, Bean Validation and even Eclipse! In many cases, they've been fixed/implemented in just a few days. Here is a list of them:

Name Issue
Spring JDBC: simplify usage of NamedParameterJdbcTemplate SPR-10256 and SPR-10257
Bean Validation / Hibernate Validator: simplify Maven dependencies and backward compatibility HV-790 and HV-792
Spring Data: provide more flexibility when working with JPQL queries DATAJPA-292

Contributing

The issue tracker is the preferred channel for bug reports, features requests and submitting pull requests.

For pull requests, editor preferences are available in the editor config for easy use in common text editors. Read more and download plugins at https://editorconfig.org. If you have not previously done so, please fill out and submit the Contributor License Agreement.

License

The Spring PetClinic sample application is released under version 2.0 of the Apache License.