Failsafe Actuator
Failsafe Actuator is a Java library that provides a simple monitoring interface for Spring Boot applications that use the Failsafe library. Using Failsafe Actuator will readily expose the state of your Circuit Breakers (closed, open, half-open) to your Spring Actuator endpoint without additional effort.
Core Technical Concepts/Inspiration
Failsafe Actuator supports Spring's dependency injection to make it easier to use Failsafe. It allows you to monitor the state of your Circuit Breakers so that, whenever a third party that your app relies upon suddenly becomes unavailable, you can discover it immediately and take action. This is essential for applications used in production.
Development Status/Project Roadmap
This library is currently under development and used in production at Zalando.
Find more details about our development plans in the Issues Tracker.
We're always looking for contributors, so if you find an interesting "Help Wanted" issue then please drop us a line in the related issue to claim it and begin working.
Unless you explicitly state otherwise in advance, any non trivial contribution intentionally submitted for inclusion in this project by you to the steward of this repository (Zalando SE, Berlin) shall be under the terms and conditions of the MIT License, without any additional copyright information, terms or conditions.
Getting Started
Dependencies/Requirements
- Java 8
- Spring Boot 2
- Failsafe
Running/Using
To use Failsafe Actuator, add the following dependency to your project:
Gradle:
compile("org.zalando:failsafe-actuator:${FAILSAFE-ACTUATOR-VERSION}")
Maven:
<dependency>
<groupId>org.zalando</groupId>
<artifactId>failsafe-actuator</artifactId>
<version>${failsafe-actuator.version}</version>
</dependency>
Create your CircuitBreaker by defining them as a Bean.
@Configuration
public class CircuitBreakerConfiguration {
@Bean
public CircuitBreaker myBreaker() {
return new CircuitBreaker();
}
}
You can use and configure the created CircuitBreaker by autowiring it in the class where it should be used.
@Component
public class MyBean {
@Autowired
private CircuitBreaker myBreaker;
}
That's it. By calling the endpoint via http://${yourAddress}/actuator/circuit-breakers. you will get a response which looks like the following:
GET /actuator/circuit-breakers
HTTP/1.1 200
Content-Type: application/json
{
"myBreaker": {
"state": "OPEN"
},
"otherBreaker": {
"state": "CLOSED"
}
}
Individual circuit breakers can be requested via /acutuator/circuit-breakers/{name}:
GET /actuator/circuit-breakers/myBreaker
HTTP/1.1 200
Content-Type: application/json
{
"state": "OPEN"
}
You can even modify the circuit breaker state and manually open or close them:
POST /actuator/circuit-breakers/myBreaker
Content-Type: application/json
{
"state": "CLOSED"
}
Example usage
To see a complete example on how to use the library take a look at the Sample Application. It starts a Rest Controller that shows how to autowire CircuitBreaker into your application and configure them.
How to build on your own
In order to build the JAR on your own run the following command:
mvn clean install
License
This code is released under the MIT license. See License.
73 Dec 26, 2022
12 Oct 19, 2022
6 Dec 15, 2022
12 Oct 27, 2022
5 Feb 28, 2022
1 Jan 18, 2022
1k Jan 1, 2023
911 Dec 9, 2022
41 Dec 30, 2022
5 Jul 28, 2022
226 Dec 20, 2022
3 Oct 17, 2021
119 Dec 21, 2022
6 Nov 1, 2022
3 Jan 30, 2022
2 Aug 4, 2022
10 Nov 27, 2022
16.6k Dec 30, 2022
951 Jan 5, 2023
14 Dec 6, 2022