Difference between revisions of "Plugin:Carbon"

From collectd Wiki
Jump to: navigation, search
(created template)
 
(make info current)
Line 3: Line 3:
 
   | Type=write
 
   | Type=write
 
   | Callbacks={{Callback|write}}
 
   | Callbacks={{Callback|write}}
   | Status={{In development}}
+
   | Status=Stable
   | FirstVersion={{In development}}
+
   | FirstVersion=Not Versioned (continuous development)
 
   | Copyright=''2010'' Gregory Szorc
 
   | Copyright=''2010'' Gregory Szorc
 
   | License={{Apache 2.0 License}}
 
   | License={{Apache 2.0 License}}
   | Manpage={{Manpage|collectd-python|5}}
+
   | Manpage=[https://github.com/indygreg/collectd-carbon/blob/master/README.md README.md] (from project)
 
}}
 
}}
The ''Carbon'' plugin writes data collected by collectd to Carbon, Graphite's storage engine.
+
The ''Carbon'' plugin writes data collected by collectd to Carbon, [http://graphite.wikidot.com/start Graphite]'s storage API. It can be found at https://github.com/indygreg/collectd-carbon.
 +
 
 +
In essence, this is an alternative writer to RRD. Graphite's web UI has very compelling features, such as interactive graphs and dynamic functions.
  
 
== Synopsis ==
 
== Synopsis ==
Line 17: Line 19:
 
  </LoadPlugin>
 
  </LoadPlugin>
 
   
 
   
  <Plugin "python">
+
  Import "carbon_writer"
   ...
+
<Module carbon_writer>
  </Plugin>
+
   LineReceiverHost "myhost.mydomain"
 +
  LineReceiverPort 2003
 +
  DeriveCounters true
 +
  TypesDB "/usr/share/collectd/types.db"
 +
  </Module>
  
 
== Example graphs ==
 
== Example graphs ==
  
{{No Example Graph}}
+
Uses Graphite for rendering. See http://graphite.wikidot.com/screen-shots for some examples.
  
 
== Caveats ==
 
== Caveats ==

Revision as of 07:41, 19 October 2011

Carbon plugin
Type: write
Callbacks: write
Status: Stable
First version: Not Versioned (continuous development)
Copyright: 2010 Gregory Szorc
License: Apache 2.0
Manpage: README.md (from project)
List of Plugins

The Carbon plugin writes data collected by collectd to Carbon, Graphite's storage API. It can be found at https://github.com/indygreg/collectd-carbon.

In essence, this is an alternative writer to RRD. Graphite's web UI has very compelling features, such as interactive graphs and dynamic functions.

Synopsis

<LoadPlugin "python">
  Globals true
</LoadPlugin>

Import "carbon_writer"
<Module carbon_writer>
  LineReceiverHost "myhost.mydomain"
  LineReceiverPort 2003
  DeriveCounters true
  TypesDB "/usr/share/collectd/types.db"
</Module>

Example graphs

Uses Graphite for rendering. See http://graphite.wikidot.com/screen-shots for some examples.

Caveats

Globals

If using versions 4.9 or 4.10, be sure to load the Python plugin with the Globals option set to true. Otherwise the Carbon module will not work properly. The appropriate configuration for loading the Python plugin is:

<LoadPlugin "python">
  Globals true
</LoadPlugin>

Versions before 4.9 don't support this option; it's possible the Carbon plugin doesn't work with these versions of collectd. Version 5.0 and later will automatically set this flag for the Python plugin, so the above syntax isn't required but still legal.

Dependencies