Spring/spring-statemachine
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Update docs

Browse Source 
- Better docs for boot support.
- Relates to #270
This commit is contained in:
Janne Valkealahti
2016-11-24 13:31:08 +00:00
parent 922473220d
commit e5bfc74f16
2 changed files with 20 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/src/reference/asciidoc/sm-examples.adoc
View File

@@ -1436,9 +1436,9 @@ with a machine configuration kept in a database. This sample is using
embedded _H2_ database with a _H2 Console_ to ease playing with a
database.
To enable automatic scan of needed _Entity_ classes and _JPA
Repositories_, a boot application can be annotated with a custom
locations as shown below.
This sample uses `spring-statemachine-boot` which on default
auto-configures repositories and entity classes needed for JPA.
Thus only `@SpringBootApplication` is needed.
[source,java,indent=0]
----

19
docs/src/reference/asciidoc/sm.adoc
View File

@@ -1736,8 +1736,12 @@ Check sample <<statemachine-examples-eventservice>> for detailed usage.
[[sm-boot]]
== Spring Boot Support
Currently support for Boot auto-configuration exists only for monitoring
and tracing. If _spring-statemachine-boot_ is in a classpath,
Auto-configuration module `spring-statemachine-boot` contains all
integration logic with _Spring Boot_ providing functionality i.e. for
auto-config and actuators. All what is needed is to have _State
Machine_ as part of a boot application together with this library.
=== Monitoring and Tracing
`BootStateMachineMonitor` is created automatically and associated with
a state machine. This `BootStateMachineMonitor` will hook into Boot's
`CounterService`, `GaugeService` and `TraceRepository` if available.
@@ -1745,6 +1749,17 @@ Optionally this auto-configuration can be disabled by setting key
`spring.statemachine.monitor.enabled` to `false`. Use of this
auto-config is shown in sample <<statemachine-examples-monitoring>>.
=== Repository Config
Spring Data Repositories and Entity class scanning is auto-configured
automatically for <<sm-repository>> if needed classes are found from a
classpath.
Currently supported configs are configured for `JPA`, `Redis` and
`MongoDB`. Repository auto-configuration can be disabled using a
properties `spring.statemachine.data.jpa.repositories.enabled`,
`spring.statemachine.data.redis.repositories.enabled` and
`spring.statemachine.data.mongo.repositories.enabled` respectively.
[[sm-monitoring]]
== Monitoring State Machine
`StateMachineMonitor` can be used to get more information about