Site updated at 2016-02-13 08:45:18 UTC

components/graphite/index.html

@@ -113,23 +113,28 @@
   <hr class="divider">
   
 
-  <p>Component that records all events and state changes and feeds the data to<br />
-a graphite installation.<br />
-Example configuration:</p>
+  <p>The <code>graphite</code> component records all events and state changes and feeds the data to a <a href="http://graphite.wikidot.com/">graphite</a> instance.</p>
+
+<p>To enable this component, add the following lines to your <code>configuration.yaml</code>:</p>
 
 <div class="highlighter-coderay"><div class="CodeRay">
   <div class="code"><pre><span class="comment"># Example configuration.yaml entry</span>
 <span class="key">graphite</span>:
-  <span class="key">host</span>: <span class="string"><span class="content">foobar</span></span>
+  <span class="key">host</span>: <span class="string"><span class="content">IP_ADDRESS</span></span>
   <span class="key">port</span>: <span class="string"><span class="content">2003</span></span>
   <span class="key">prefix</span>: <span class="string"><span class="content">ha</span></span>
 </pre></div>
 </div>
 </div>
 
-<p>All config elements are optional, and assumed to be on localhost at the<br />
-default port if not specified. Prefix is the metric prefix in graphite,<br />
-and defaults to ‘ha’.</p>
+<p>Configuration variables:</p>
+
+<ul>
+  <li><strong>host</strong> (<em>Option</em>): IP address of your graphite host, eg. http://192.168.1.10. Defaults to <code>localhost</code></li>
+  <li><strong>port</strong> (<em>Optional</em>): Port to use. Defaults to 2003.</li>
+  <li><strong>prefix</strong> (<em>Optional</em>):  Prefix is the metric prefix in graphite. Defaults to <code>ha</code>.</li>
+</ul>
+
 
 
 </article>