Skip to content

Commit ab69ce2

Browse files
committed
update README
1 parent 183ce92 commit ab69ce2

1 file changed

Lines changed: 30 additions & 2 deletions

File tree

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,12 @@ This repository is the cornerstone of BBData. It contains:
2020
* [Minimal properties to provide](#minimal-properties-to-provide)
2121
* [Executing the jar](#executing-the-jar)
2222
* [Caching](#caching)
23+
* [Async](#async)
2324
- [Permission system](#permission-system)
24-
- [Customizing the `/info` endpoint](#customizing-the-info-endpoint)
25+
- [Actuators](#actuators)
26+
* [Customizing the `/info` endpoint](#customizing-the-info-endpoint)
27+
* [Hidden async task executor endpoint](#hidden-async-task-executor-endpoint)
28+
* [Changing exposed actuators](#changing-exposed-actuators)
2529

2630
## Development setup
2731

@@ -195,6 +199,13 @@ Current caching strategy:
195199
* the entire cache is flushed when an object changes state (enabled/disabled), this is because we use compound keys,
196200
and have no way of using wildcard (e.g. `objectId:*`) in `@CacheEvict`. However, this operation is usually rare.
197201

202+
### Async
203+
204+
To speed up the input endpoints, object statistics are updated asynchronously.
205+
Under the hood, a `TheadPoolTaskExecutor` is configured through the `spring.task.execution.*` properties (see `application.properties`
206+
in this repo for default values). You can of course override any of those in your properties file.
207+
208+
If you want to **TURN OFF** asynchronous processing, simply set the custom property `async.enabled=false`.
198209

199210
## Permission system
200211

@@ -217,7 +228,9 @@ This is the equivalent of `SUDO`: any admin of this group has read/write access
217228

218229
(see the documentation for more info)
219230

220-
## Customizing the `/info` endpoint
231+
## Actuators
232+
233+
### Customizing the `/info` endpoint
221234

222235
The info endpoint can be customized using properties.
223236

@@ -241,3 +254,18 @@ dynamic.info.<JSON-KEY-NAME-WITHOUT-DOTS>=<ANOTHER PROPERTY>
241254
```
242255

243256
To hide a dynamic property that is displayed, simply redefine it with an empty value, e.g. `dynamic.info.cache-type=`.
257+
258+
### Hidden async task executor endpoint
259+
260+
By default, and if `sync.enabled=true`, there is a hidden `/tasks` endpoint that returns statistics about the task executor
261+
(core size, active threads) and the tasks. I is though hidden from the swagger documentation.
262+
263+
To disable this endpoint, see changing exposed actuators.
264+
265+
### Changing exposed actuators
266+
267+
By default, the exposed actuators are:
268+
```properties
269+
management.endpoints.web.exposure.include=info, health, metrics, tasks
270+
```
271+
Feel free to change this list as you see fit, but remember that they are all public !

0 commit comments

Comments
 (0)