README

   1  collection 4 - An efficient graphing front-end for collectd
   2 =============================================================
   3
   4 About
   5 -----
   6
   7   collection 4 (c4) is a web-based front-end to the RRD files updated by
   8   collectd. It is designed to be highly efficient and handle large
   9   installations - with 50,000 and more RRD files - well.
  10
  11
  12 Concepts
  13 --------
  14
  15   c4 lets you configure "graphs" in its config file. Each graph has a selector
  16   which determines which files will be used to draw the graph. The selector
  17   uses the host/plugin[-instance]/type[-instance] layout known from collectd.
  18   Each field of the selector may be one of two wildcard expressions:
  19
  20     * "/any/"
  21       The field may be any value. The files will be grouped by the values of
  22       all "/any/" fields. Think of the "GROUP BY" SQL expression. Each grouping
  23       is called an "instance" which can be identified by the graph selector and
  24       the value of the "/any/" fields.
  25
  26     * "/all/"
  27       As with the any-selector, the field may be any value. However, all files
  28       that only differ in the "/all/" field(s) will be printed in the same
  29       graph.
  30
  31   Upon startup, c4 will read the configuration and scan the directory
  32   containing the RRD files. Each file is added to all matching graphs, either
  33   by adding it to the appropriate instance or by creating a new instance. I.e.
  34   each file may be used in multiple graphs.
  35
  36
  37 Author
  38 ------
  39
  40   Florian "octo" Forster <ff at octo.it>
  41