If you run into a bug while using jclouds, we encourage you to report it. To help us help you, please collect as much of the following information as possible. If you can't get everything, that's okay. Send what you can.

Bugs can be reported in JIRA or via the jclouds user mailing list.

  1. jclouds Version
  2. Cloud and API Version
  3. Operating System Version
  4. Java Version
  5. Logs
  6. Code
  7. Documentation

jclouds Version

The version of jclouds can be found in the name of the JAR files you are using in your application or the pom.xml file of your application if you're using Maven.

e.g. jclouds Version: 1.7.1

Cloud and API Version

If you are using a private cloud such as OpenStack, CloudStack, or vCloud, you might be able to report the Cloud and API version.

e.g. Cloud and API Version: OpenStack Havana, Cinder API v2

Operating System Version

The Operating System Version you're using.

e.g. Operating System Version: Mac OS X 10.7.5

Java Version

The Java Version you're using.

e.g. java version "1.7.0_51"

Logs

Sending us the stack trace from the exception is helpful but often the root cause of the problem can be revealed by examining what's being sent over the wire. Please read Logging to install, configure, and enable logging.

If you are reporting the bug in JIRA, you can simply attach the jclouds-wire.log and other logs to the issue. If you are sending the report to the user mailing list, please put the logs into a gist or pastie and include the link in the email.

Code

If you can isolate the problem within a single Java file, send us that file so we can attempt to immediately reproduce the error. If you can't isolate the problem, send us as large a code snippet as possible around the problem code.

If you are reporting the bug in JIRA, you can simply attach the code to the issue. If you are sending the report to the user mailing list, please put the code into a gist or pastie and include the link in the email.

Please remember to remove all credentials and other sensitive information from anything you share!

Documentation

If you find a bug in the documentation, you can report that via JIRA or the user mailing list too. However it is quite easy to fix the documentation (this website) and we encourage you to do so by reading How to Contribute Documentation.