emicklei / selfdiagnose

a Java library of diagnotistic tasks that can verify the availability of external resources required for the execution of a J2EE application.

SelfDiagnose

SelfDiagnose is a library of diagnotistic tasks that can verify the availability of external resources required for the execution of a Java web application.

How does it help?

When applications are deployed on a development, test or production environment, you need to perform integration tests to verify that all systems are working together and provide the application functionality. Although your application is properly JUnit tested, the validity highly depends on its environment. For instance, the Web container should accept incoming requests, database connections can be established, log files are writeable, etc. Depending on your level of automation in deployment, problems in the configuration of your environment will prevent the application from working as expected. And even if your environment is setup correctly, will it be available 24x7? SelfDiagnose can help detect such problems during both deployment and in production. Reports can provide information about possible causes of application problems that are related to the availability of external resources.

How does it work?

SelfDiagnose provides a collection of diagnostic tasks that check some external or internal aspect required by the application. For instance, the task CheckURLReachable verifies that a connection to a server can be opened. The task CheckJNDIBinding verifies that a resource can be found in a naming server. CheckDatabaseTableExists simply does what it says. Using a simple XML configuration, you specifiy which tasks should run. Running the tasks is requested through a servlet that responds with a report.

Documentation

The documentation of the project is currently being moved from the old Sourceforge site to the GitHub wiki pages. The GitHub wiki will be up to date but the the Sourceforge documentation may still be more complete.

New documentation (work in progress)

Old Documentation

© 2004-2016. ernestmicklei.com, Apache License 2.0

selfdiagnose's Issues

task result message is not escaped in XML

causing reports of invalid XML documents

Wiki not accurate

The Wiki page is not accurate:

• The XSD mentioned in 'Getting Started' is not reachable (404 - Not Found);
• In Task Overview the examples are incorrect, for example "checkdirectoryaccessible". According to the example the element has name, read and write as attributes. According to the xsd@githubusercontent these should be path and writeable;
• The "Creating custom tasks" links to "../selfdiagnose/wiki/Creating-custom-tasks" which does not exist. "../selfdiagnose/wiki/Custom-tasks" does exist.

make available in Maven Central

and clean up pom

Example for Spring Managed Bean

Do you have a fully working example for a Spring Managed Bean? According to the Wiki it should be quite straightforward, but the html just returns a FAILED indication. There's no logging from selfdiagnose, and the run(ExecutionContext...) method is not being called.

I'm using Spring annotations btw.

Thanks,
Bernard Tocht

Improvement: Severity level info

It' be nice to have an info Severity level (e.g. INFO). I would like to use it to report the java version.