tree: 7533ea9b220f7068ab5b96681efd926dad5690ab [path history] [tgz]
  1. docs/
  2. src/
  3. .travis.yml
  4. bnd.bnd
  5. LICENSE
  6. pom.xml
  7. README.md
systemready/README.md

OSGi system ready check framework

Felix System Ready is obsolete and superseded by Apache Felix Health Checks. Use the out-of-the-box health checks in bundle org.apache.felix.healthcheck.generalchecks.

Old documentation

Build Status Maven Central

In OSGi there is always the question of when a system is fully operational after startup. This project provides a framework to configure and create so called system checks and signal the ready state of an OSGi based system. In addition to the framework, we also provide some generic checks that give a solid basis, like a check waiting for the startup of bundles to finish, as well as certain OSGi services being present. Additionally, root cause analysis in case of error states is conveniently presented. Custom checks can be created to provide in-depth checks for your own functionality.

See why system ready for some more background on why to use this project.

Usage

See reference documentation.

Build

mvn clean install

Also check the Jenkins build

Issue reporting

We currently have these open issues. Please report issues using projectFelix and Component System Ready.

Working with the code

As contributor the easiest way is to fork the Felix project on github and do a pull request. We do not actively monitor pull requests so please also open an issue.

When creating a PR it is a good practice to first create a branch named like the jira issue id. The commit message should also refer to the issue id. Like FELIX-1234 My message.