Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adambien/porcupine
Threading, Resiliency and Monitoring for Java EE 7/8
https://github.com/adambien/porcupine
cloud cloud-native executorservice injectable-statistics java microservices monitoring overload porcupine resiliency statistics threading
Last synced: 19 days ago
JSON representation
Threading, Resiliency and Monitoring for Java EE 7/8
- Host: GitHub
- URL: https://github.com/adambien/porcupine
- Owner: AdamBien
- License: apache-2.0
- Created: 2015-01-09T08:54:07.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2016-12-23T15:42:44.000Z (almost 8 years ago)
- Last Synced: 2023-07-26T21:12:53.720Z (over 1 year ago)
- Topics: cloud, cloud-native, executorservice, injectable-statistics, java, microservices, monitoring, overload, porcupine, resiliency, statistics, threading
- Language: Java
- Homepage:
- Size: 99.6 KB
- Stars: 96
- Watchers: 13
- Forks: 22
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# porcupine
Configurable threading, resiliency and monitoring with injectable statistics for Java EE 7. Porcupine is the implementation of the [bulkhead](https://johnragan.wordpress.com/2009/12/08/release-it-stability-patterns-and-best-practices/) and [handshaking](https://johnragan.wordpress.com/2009/12/08/release-it-stability-patterns-and-best-practices/) patterns for Java EE 7.
Features:
1. Conventional: ExecutorService is directly injectable. The thread pool derives the name from the field, but can be easily overridden.
2. Drop-in install: a single dependency in the pom.xml is sufficient.
3. Standard based: porcupine uses [JSR 236: Concurrency Utilities for JavaTM EE](https://www.jcp.org/en/jsr/detail?id=236)
4. Small: the entire framework is: 16kB.
5. Extensible without configuration: All major components can be replaced (big thanks to [@Specializes](http://docs.oracle.com/javaee/7/api/javax/enterprise/inject/Specializes.html))
### Booting Porcupine
[](https://www.youtube.com/embed/20KVZ0ZnCl4?rel=0)
### Configuration
[](https://www.youtube.com/embed/4M1EJntwjk8?rel=0)
### Dealing with Overload
[](https://www.youtube.com/embed/HToJuV28pPI?rel=0)
### Automatic Statistics Injection
[](https://www.youtube.com/embed/0slZph_LC0A?rel=0)
##Installation
```
com.airhacks
porcupine
NEWEST_VERSION
compile
```
With statistics injection into HTTP headers of all JAX-RS resources:
```
com.airhacks
porcupine-spy
NEWEST_VERSION
compile
```
##Conventional Usage
```
@Stateless
public class MessagesService {
@Inject
@Dedicated
ExecutorService light;
@Inject
@Dedicated
ExecutorService heavy;
```
Custom naming is also supported:
```
@Inject
@Dedicated("custom-pool")
private ExecutorService first;
```
##Statistics and monitoring
###Exposure
@Path("statistics")
@RequestScoped
@Produces({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
public class StatisticsResource {
@Inject
Instance> statistics;
@GET
public List expose() {
return this.statistics.get();
}
}
###Sample output
Unified thread pool statistics are accessible via injection. Individual statistics are injectable with the `@Dedicated` qualifier.
XML statistics
```
light
100
1
0
1
1
1
48
ExecutorServiceExposer$$Lambda$3/1562863014
0
heavy
16
0
1
1
1
1
8
CallerRunsPolicy
0
```
JSON statistics
```
[{
"pipelineName": "light",
"remainingQueueCapacity": 100,
"completedTaskCount": 1,
"activeThreadCount": 0,
"largestThreadPoolSize": 1,
"currentThreadPoolSize": 1,
"totalNumberOfTasks": 1,
"maximumPoolSize": 48,
"rejectedExecutionHandlerName": "ExecutorServiceExposer$$Lambda$3/1562863014",
"rejectedTasks": 0
},
{
"pipelineName": "heavy",
"remainingQueueCapacity": 16,
"completedTaskCount": 1,
"activeThreadCount": 0,
"largestThreadPoolSize": 1,
"currentThreadPoolSize": 1,
"totalNumberOfTasks": 1,
"maximumPoolSize": 8,
"rejectedExecutionHandlerName": "CallerRunsPolicy",
"rejectedTasks": 0
}]
```
## Custom configuration (fully optional)
```
@Specializes
public class CustomExecutorConfigurator extends ExecutorConfigurator {
@Override
public ExecutorConfiguration defaultConfigurator() {
return super.defaultConfigurator();
}
@Override
public ExecutorConfiguration forPipeline(String name) {
if ("heavy".equals(name)) {
return new ExecutorConfiguration.Builder().
corePoolSize(4).
maxPoolSize(8).
queueCapacity(16).
keepAliveTime(1).
callerRunsPolicy().
build();
}
return super.forPipeline(name);
}
}
```
## Statistics Injection into HTTP Headers
```
HTTP/1.1 200 OK
Server: GlassFish Server Open Source Edition 4.1
X-Powered-By: Servlet/3.1 JSP/2.3 (GlassFish Server Open Source Edition 4.1 Java/Oracle Corporation/1.8)
```
```json
x-porcupine-statistics-light: {"pipelineName":"light","activeThreadCount":1,"completedTaskCount":1,
"corePoolSize":8,"currentThreadPoolSize":2,"largestThreadPoolSize":2,"maximumPoolSize":16,"rejectedTasks":0,
"remainingQueueCapacity":100,"minQueueCapacity":100,"totalNumberOfTasks":2}
x-porcupine-statistics-heavy: {"pipelineName":"heavy","rejectedExecutionHandlerName":"CallerRunsPolicy",
"activeThreadCount":0,"completedTaskCount":1,"corePoolSize":4,"currentThreadPoolSize":1,
"largestThreadPoolSize":1,"maximumPoolSize":8,"rejectedTasks":0,"remainingQueueCapacity":16,
"minQueueCapacity":16,"totalNumberOfTasks":1}
```
```
Content-Type: text/plain
Date: Wed, 18 Mar 2015 07:50:20 GMT
Content-Length: 36
```