Spring Batch Admin provides a web-based user interface that features an admin console for Spring Batch applications and systems. It is a new open-source project from SpringSource. A milestone release 1.0.0.M1 will be available soon with all the features below, and we hope to get to a 1.0.0 final release early in 2010.
Main Use Cases
The easiest way to get a quick overview of Spring Batch Admin is to see some screenshots of the main use cases. The user interface is a web application (built with Spring MVC).
The user can inspect the jobs that are known to the system. Jobs are either launchable or non-launchable (in the screenshot they are all launchable). The distinction is that a launchable job is defined and configured in the application itself, whereas a non-launchable job is detected as state left by the execution of a job in another process. (Spring Batch uses a relational database to track the state of jobs and steps, so historic executions can be queried to show the non-launchable jobs.)
Launchable jobs can be launched from the user interface with job parameters provided as name value pairs, or by an incrementer configured into the application.
Once a job is executing, or has executed, this view can be used to see the most recent executions, and a brief summary of their status (STARTED, COMPLETED, FAILED, etc.).
Each individual execution has a more detailed view (shown above), and from there the user can click down to a view of each of the step executions in the job (only one in this case). A common reason for wanting to do this is to see the cause of a failure.
The top of the step execution detail view shows the history of the execution of this step across all job executions. This is useful for getting a statistical feel for performance characteristics. A developer running a job in an integration test environment might use the statistics here to compare different parameterisations of a job, to see what effect is of changing (for instance) the commit interval in an item processing step.
The bottom of the step execution view has the detailed meta-data for the step (status, read count, write count, commit count, etc.) as well as an extract of the stack trace from any exception that caused a failure of the step (as in the example shown above).
Stop an Execution
A job that is executing can be stopped by the user (whether or not it is launchable). The stop signal is sent via the database and once detected by Spring Batch in whatever process is running the job, the job is stopped (status moves from STOPPING to STOPPED) and no further processing takes place.
Where to get it
The best place to start is the SpringSource community download page. There is also a snapshot download attached to this article, or you can get the source code from subversion and compile it yourself. Snapshot builds also go up to S3 to the Maven repository every night:
<repository> <id>spring-snapshots</id> <name>Spring Maven Snapshot Repository</name> <url>http://s3.amazonaws.com/maven.springframework.org/snapshot</url> </repository>
There are two JAR artifacts and a WAR sample (org.springframework.batch:spring-batch-admin-sample:war), all of which are in the Maven repository and in SVN. In the the case of the WAR download link from this article the JAR files are included in WEB-INF/lib.
To deploy the sample application just install the WAR into your favourite servlet container, or import the source code into STS and launch the sample with standard Eclipse WTP features (e.g. drag it onto the server or Run As… and run on the server). It uses an in-memory database out of the box, so you will get a fresh copy on each restart of the application.
- Uploading Job Configurations to Spring Batch Admin
- Spring Framework Maven Artifacts
- Running a Spring Batch Job in The SpringSource Application Platform
- Maven Artifacts
- Practical Use of Spring Batch and Spring Integration