You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@jclouds.apache.org by ev...@apache.org on 2013/09/18 06:53:06 UTC
svn commit: r1524293 - in /incubator/jclouds/site-content/documentation:
jcloudsguides/index.html userguide/bug-report/
userguide/bug-report/index.html
Author: everett
Date: Wed Sep 18 04:53:06 2013
New Revision: 1524293
URL: http://svn.apache.org/r1524293
Log:
deploy jclouds site content
Added:
incubator/jclouds/site-content/documentation/userguide/bug-report/
incubator/jclouds/site-content/documentation/userguide/bug-report/index.html
Modified:
incubator/jclouds/site-content/documentation/jcloudsguides/index.html
Modified: incubator/jclouds/site-content/documentation/jcloudsguides/index.html
URL: http://svn.apache.org/viewvc/incubator/jclouds/site-content/documentation/jcloudsguides/index.html?rev=1524293&r1=1524292&r2=1524293&view=diff
==============================================================================
--- incubator/jclouds/site-content/documentation/jcloudsguides/index.html (original)
+++ incubator/jclouds/site-content/documentation/jcloudsguides/index.html Wed Sep 18 04:53:06 2013
@@ -62,6 +62,7 @@
<h2>jclouds Basics to get Started</h2>
<ul>
+<li><a href="/documentation/userguide/bug-report">How to Report a Bug</a></li>
<li><a href="/documentation/userguide/karaf">Using the CLI with Apache Karaf</a></li>
<li><a href="/documentation/userguide/using-maven">Building with Apache Maven</a></li>
</ul>
Added: incubator/jclouds/site-content/documentation/userguide/bug-report/index.html
URL: http://svn.apache.org/viewvc/incubator/jclouds/site-content/documentation/userguide/bug-report/index.html?rev=1524293&view=auto
==============================================================================
--- incubator/jclouds/site-content/documentation/userguide/bug-report/index.html (added)
+++ incubator/jclouds/site-content/documentation/userguide/bug-report/index.html Wed Sep 18 04:53:06 2013
@@ -0,0 +1,161 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
+
+<head>
+ <title>Apache jclouds® :: Documentation</title>
+ <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
+
+ <!-- **** jclouds stylesheet **** -->
+ <link rel="stylesheet" type="text/css" href="/style/style.css"/>
+
+ <!-- **** syntax highlighting stylesheet **** -->
+ <link rel="stylesheet" type="text/css" href="/style/syntax.css"/>
+
+ <!-- **** Google Fonts **** -->
+ <link href='http://fonts.googleapis.com/css?family=Droid+Sans+Mono' rel='stylesheet' type='text/css'>
+ <link href='http://fonts.googleapis.com/css?family=Varela+Round' rel='stylesheet'/>
+
+ <script type="text/javascript">
+
+ var _gaq = _gaq || [];
+ _gaq.push(['_setAccount', 'UA-8638379-1']);
+ _gaq.push(['_trackPageview']);
+
+ (function() {
+ var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
+ ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
+ var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
+ })();
+
+ </script>
+
+</head>
+
+<body>
+ <div id="main">
+ <div id="top">
+ <a href="/"><div id="logo"></div></a>
+ <div id="menu">
+ <ul>
+<li><a href="/documentation/gettingstarted/">Getting Started</a></li>
+<li><a href="/documentation/">Documentation</a></li>
+<li><a href="/documentation/community/">Community</a></li>
+<li><a href="/documentation/devguides/">Development</a></li>
+<li><a href="http://incubator.apache.org/projects/jclouds.html">Contact</a></li>
+</ul>
+
+ <!-- This bit of liquid lets us render the template components as markdown -->
+ </div>
+ </div>
+ <div id="content">
+ <div id="column2">
+ <h1>How to Report a Bug to Apache jclouds®</h1>
+
+<p>If you run into a bug while using jclouds, we encourage you to report it. To 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.</p>
+
+<p>Bugs can be reported in <a href="https://issues.apache.org/jira/browse/JCLOUDS">JIRA</a> or the <a href="mailto:user@jclouds.incubator.apache.org">jclouds user mailing list</a> (<a href="mailto:jclouds-user-subscribe@apache.org">subscribe</a>).</p>
+
+<ol>
+<li><a href="#jclouds-version">jclouds Version</a></li>
+<li><a href="#cloud-version">Cloud and API Version</a></li>
+<li><a href="#os-version">Operating System Version</a></li>
+<li><a href="#java-version">Java Version</a></li>
+<li><a href="#logs">Logs</a></li>
+<li><a href="#code">Code</a></li>
+<li><a href="#doc">Documentation</a></li>
+</ol>
+
+
+<h2><a id="jclouds-version"></a>jclouds Version</h2>
+
+<p>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.</p>
+
+<p>E.G. jclouds Version: 1.6.2-incubating</p>
+
+<h2><a id="cloud-version"></a>Cloud and API Version</h2>
+
+<p>If you are using a private cloud such as OpenStack, CloudStack, or vCloud, you might be able to report the Cloud and API version.</p>
+
+<p>E.G. Cloud and API Version: OpenStack Grizzly, Cinder API v2</p>
+
+<h2><a id="os-version"></a>Operating System Version</h2>
+
+<p>The Operating System Version you're using.</p>
+
+<p>E.G. Operating System Version: Mac OS X 10.7.5</p>
+
+<h2><a id="java-version"></a>Java Version</h2>
+
+<p>The Java Version you're using.</p>
+
+<p>E.G. java version "1.7.0_17"</p>
+
+<h2><a id="logs"></a>Logs</h2>
+
+<p>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.</p>
+
+<h3>Get Logging</h3>
+
+<p><a href="http://www.slf4j.org/">SLF4J</a> is the logging facade for jclouds. To use SLF4J you need the jclouds-slf4j-X.X.X.jar and the implementation logback-*.jar (<a href="http://logback.qos.ch/download.html">download</a>) files on your classpath. To get them via Maven add the following dependencies to your pom.xml file.</p>
+
+<div class="highlight"><pre><code class="xml"><span class="nt"><dependencies></span>
+ <span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>org.apache.jclouds.driver<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>jclouds-slf4j<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>${jclouds.version}<span class="nt"></version></span>
+ <span class="nt"></dependency></span>
+ <span class="nt"><dependency></span>
+ <span class="nt"><groupId></span>ch.qos.logback<span class="nt"></groupId></span>
+ <span class="nt"><artifactId></span>logback-classic<span class="nt"></artifactId></span>
+ <span class="nt"><version></span>1.0.13<span class="nt"></version></span>
+ <span class="nt"></dependency></span>
+<span class="nt"></dependencies></span>
+</code></pre></div>
+
+
+<h3>Configure Logging</h3>
+
+<p>You'll also need a logback.xml (<a href="https://github.com/jclouds/jclouds/blob/master/compute/src/test/resources/logback.xml">example</a>) configuration file on your classpath. It's the appender named WIREFILE that we need.</p>
+
+<h3>Enable Logging</h3>
+
+<p>Here is some example code of how to enable your components to use SLF4J:</p>
+
+<div class="highlight"><pre><code class="java"> <span class="n">Iterable</span><span class="o"><</span><span class="n">Module</span><span class="o">></span> <span class="n">modules</span> <span class="o">=</span> <span class="n">ImmutableSet</span><span class="o">.<</span><span class="n">Module</span><span class="o">></span> <span class="n">of</span><span class="o">(</span>
+ <span class="k">new</span> <span class="nf">SLF4JLoggingModule</span><span class="o">());</span>
+
+ <span class="n">ComputeServiceContext</span> <span class="n">context</span> <span class="o">=</span> <span class="n">ContextBuilder</span><span class="o">.</span><span class="na">newBuilder</span><span class="o">(</span><span class="s">"a-compute-provider"</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">credentials</span><span class="o">(</span><span class="s">"myUsername"</span><span class="o">,</span> <span class="s">"myPasswordOrApiKey"</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">modules</span><span class="o">(</span><span class="n">modules</span><span class="o">)</span>
+ <span class="o">.</span><span class="na">buildView</span><span class="o">(</span><span class="n">ComputeServiceContext</span><span class="o">.</span><span class="na">class</span><span class="o">);</span>
+</code></pre></div>
+
+
+<h3>Send Logs</h3>
+
+<p>If you are reporting the bug in JIRA, you can simply attach the WIREFILE and other logs to the issue. If you are sending the report to the user mailing list, please put the logs into a <a href="https://gist.github.com/">gist</a> or <a href="http://pastie.org/">pastie</a> and include the link in the email.</p>
+
+<h2><a id="code"></a>Code</h2>
+
+<p>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.</p>
+
+<p>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 <a href="https://gist.github.com/">gist</a> or <a href="http://pastie.org/">pastie</a> and include the link in the email.</p>
+
+<h2><a id="doc"></a>Documentation</h2>
+
+<p>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 <a href="https://wiki.apache.org/jclouds/How%20to%20Contribute%20Documentation">How to Contribute Documentation</a>.</p>
+
+ </div>
+ </div>
+ <div id="footer">
+ <p>Copyright © 2011-2013 <a href="http://www.apache.org">The Apache Software Foundation</a>. All Rights Reserved.</p>
+
+<p>Apache, jclouds, Apache jclouds, the jclouds logo, and the Apache feather logos are registered trademarks or trademarks of the Apache Software Foundation.</p>
+
+<p><a href="http://www.apache.org/licenses/">License</a> | <a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a> | <a href="http://www.apache.org/foundation/thanks.html">Thanks</a> | <a href="http://www.apache.org/security/">Security</a></p>
+ <!-- This bit of liquid lets us render the template components as markdown -->
+ <a href="http://www.apache.org"><img src="http://incubator.apache.org/images/egg-logo.png"/></a>
+ </div>
+ </div>
+</body>
+</html>