Difference between revisions of "Plugin:Carbon"

From collectd Wiki
Jump to: navigation, search
m (update template fields to more appropriate values)
 
(2 intermediate revisions by one other user not shown)
Line 3: Line 3:
 
   | Type=write
 
   | Type=write
 
   | Callbacks={{Callback|write}}
 
   | Callbacks={{Callback|write}}
   | Status={{supported}}
+
   | Status={{deprecated}}
 
   | FirstVersion={{Version|4.9}}
 
   | FirstVersion={{Version|4.9}}
 
   | Copyright=''2010'' Gregory Szorc
 
   | Copyright=''2010'' Gregory Szorc
Line 9: Line 9:
 
   | Manpage=[https://github.com/indygreg/collectd-carbon/blob/master/README.md README.md] (from project)
 
   | 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, [http://graphite.wikidot.com/start Graphite]'s storage API. It can be found at https://github.com/indygreg/collectd-carbon.
+
The ''Carbon'' plugin writes data collected by ''collectd'' to Carbon, [http://graphite.wikidot.com/start Graphite]'s storage API. It can be found at {{Github|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.
 
In essence, this is an alternative writer to RRD. Graphite's web UI has very compelling features, such as interactive graphs and dynamic functions.
 +
 +
For [[version 5.1]] and later using the {{Plugin|Write Graphite}} is highly recommended.
  
 
== Synopsis ==
 
== Synopsis ==
Line 42: Line 44:
  
 
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.
 
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.
 +
 +
== See also ==
 +
 +
* {{Plugin|Write Graphite}}<br />C-based plugin to send data to Graphite / Carbon efficiently. Included in ''collectd'' since [[version 5.1]].
  
 
== Dependencies ==
 
== Dependencies ==
Line 48: Line 54:
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]
{{DEFAULTSORT:Openvz}}
+
{{DEFAULTSORT:carbon}}

Latest revision as of 01:34, 12 March 2020

Carbon/Graphite plugin
Type: write
Callbacks: write
Status: deprecated
First version: 4.9
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 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.

For version 5.1 and later using the Write Graphite plugin is highly recommended.

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.

See also

Dependencies