Difference between revisions of "Plugin:Aggregation"

From collectd Wiki
Jump to: navigation, search
(Add todo.)
(Document the naming schema.)
Line 10: Line 10:
 
}}
 
}}
  
The '''Aggregate plugin''' allows to aggregate multiple values into a single value using one or several consolidation functions, e.g. summation and average.
+
The '''Aggregate plugin''' allows to aggregate multiple values into a single value using one or several consolidation functions, e.g. summation and average. This has a broad range of applications, e.g. calculating the average CPU utilization over all cores of each host or calculating the sum of the system load of all hosts.
  
'''TODO''': Discuss naming schema.
+
== Naming schema ==
 +
 
 +
New names are automatically generated for the aggregated values. They all have the ''plugin'' field set to ''aggregation''. The exact naming follows these rules:
 +
 
 +
* ''Host:'' The host is copied from the original [[value list]]s unless the ''Host'' option is left unspecified in which case it will be set to ''global''.
 +
* ''Plugin:'' The plugin is set to ''aggregation''.
 +
* ''Plugin instance:'' The plugin instance contains plugin and plugin instance of the original value list and the aggregation function used. The three parts are separated by dashes. If ''Plugin'' or ''PluginInstance'' (or both) is unspecified, that part will be omitted.
 +
* ''Type:'' The type cannot be left unspecified and is copied from the original value lists.
 +
* ''Type instance:'' The type instance is copied from the original value lists unless the ''TypeInstance'' option is left unspecified in which case it will be left empty.
  
 
== Synopsis ==
 
== Synopsis ==
Line 20: Line 28:
 
  <Plugin "aggregation">
 
  <Plugin "aggregation">
 
   <Aggregation>
 
   <Aggregation>
    Host "/any/"
 
 
     Plugin "example"
 
     Plugin "example"
    PluginInstance "/all/"
 
 
     Type "gauge"
 
     Type "gauge"
     TypeInstance "/any/"
+
      
+
    GroupBy "Host"
 +
    GroupBy "TypeInstance"
 +
   
 
     CalculateNum false
 
     CalculateNum false
 
     CalculateSum false
 
     CalculateSum false

Revision as of 23:08, 10 November 2012

Aggregate plugin
Type: read / write
Callbacks: config, read, write
Status: in development
First version: 5.2
Copyright: 2012 Florian octo Forster
License: MIT license
Manpage: collectd.conf(5)
List of Plugins

The Aggregate plugin allows to aggregate multiple values into a single value using one or several consolidation functions, e.g. summation and average. This has a broad range of applications, e.g. calculating the average CPU utilization over all cores of each host or calculating the sum of the system load of all hosts.

Naming schema

New names are automatically generated for the aggregated values. They all have the plugin field set to aggregation. The exact naming follows these rules:

  • Host: The host is copied from the original value lists unless the Host option is left unspecified in which case it will be set to global.
  • Plugin: The plugin is set to aggregation.
  • Plugin instance: The plugin instance contains plugin and plugin instance of the original value list and the aggregation function used. The three parts are separated by dashes. If Plugin or PluginInstance (or both) is unspecified, that part will be omitted.
  • Type: The type cannot be left unspecified and is copied from the original value lists.
  • Type instance: The type instance is copied from the original value lists unless the TypeInstance option is left unspecified in which case it will be left empty.

Synopsis

→ See: Plugin:Aggregation/Config
<Plugin "aggregation">
  <Aggregation>
    Plugin "example"
    Type "gauge"
    
    GroupBy "Host"
    GroupBy "TypeInstance"
    
    CalculateNum false
    CalculateSum false
    CalculateAverage true
    CalculateMinimum false
    CalculateMaximum false
    CalculateStddev false
  </Aggregation>
</Plugin>

Dependencies

  • None