Getting Help

If you are experiencing problems using Karaf then please report your problem to our Issue Tracker. You may also find it useful to discuss your issues with the community on the Discussion Forums.

How to get help

Before you report a problem you might want to read the FAQ.
Whenever you are reporting a problem please be sure to include as much information as possible; the more we know the more chance of a quicker resolution.

  • Which Karaf version you're using
  • what platform and JDK?
  • The particular OSGi container being used - if so what version
  • Stack traces generally really help! If in doubt include the whole thing; often exceptions get wrapped in other exceptions and the exception right near the bottom explains the actual error, not the first few lines at the top. It's very easy for us to skim-read past unnecessary parts of a stack trace.
  • Log output can be useful too; sometimes enabling DEBUG logging can help
  • Your code & configuration files are often useful. Be careful not to send us anything of a sensitive nature.
  • Did it work before, what have you changed to break it?
  • Try upgrading to the latest release and see if it's fixed in that release
  • Try the latest SNAPSHOT to see if it's fixed in that release
  • Search the user forum to see if has been discussed before
  • See the Known Issues section in the Release Notes for the Karaf version you're using
  • Check the issue tracker to see if the issue already have been reported

How to get help faster

We may be able to help you much more quickly if you try the following

  • Provide us with a JUnit test case that demonstrates your issue. e.g. if you think you've found a bug, can you create a test case to demonstrate the bug?
  • Submit a patch fixing the bug! (We also buy you beer when we meet you if you submit bug fixes :) )
  • For memory leak or performance related issues, if you can run a profiler on your test case and attach the output as a file (or zipped file if it's huge) to the JIRA we can normally fix things much quickly. E.g. you could run jmap/jhat, JProfiler or YourKit on your code and send us the output. To find memory leaks it's quicker to resolve if you can tell us what classes are taking up all of the RAM; we can normally figure out what's wrong from that.

Commercial Support

This is an open source project, so the amount of time we have available to help resolve your issue is often limited as all help is provided on a volunteer basis. If you want to get priority help, need to get up to speed quickly, require some training or mentoring, or need full 24 x 7 production support you could contact one of the following companies with Commercial Karaf Offerings.