Cacti (home)ForumsDocumentation

aggregate

type:
plugin
plugin:
aggregate
author:
gandalf
description:
This plugin aggregates graphs from Graph Management
version:
N/A
statu:
core
cacti:
N/A
date:
N/A
license:
GPL v2
plugins:
graph

Please note that this plugin has been merged into the base of Cacti 1.x on GitHub. Older versions of this plugin are maintained here for reference only.

Download

Archive (Cacti 0.8.8): Version 1.10

Archive (Cacti 0.8.8): Version 0.75

Archive (Cacti 0.8.8): Version 0.74

Archive (Cacti 0.8.8): Version 0.73

Archive (Cacti 0.8.8): Version 0.71

Archive (Cacti 0.8.8): Version 0.70 B2

Manual for pre 1.x Versions: PDF: Complete HowTo, including lots of examples

Purpose

Please note that this plugin has been merged into the base of Cacti 1.x on GitHub. Older versions of this plugin are maintained here for reference only.

This plugin aggregates graphs from Graph Management. All data you want to see must already be present on any existing graphs.

There are two main version families of this plugin. The version 0.7x versions do not provide the ability to create aggregate templates while the 1.x version of the plugin do allow for this method of creating the aggregates.

Features

  1. Aggregates existing Graphs into a single Aggregate Graph, keeping the sequence of selected Graphs and of the Graph Items within theses Graphs.
  2. Provides a new Graph Title for the Aggregate.
  3. Prepends all legend items with an optional text.
  4. Provides an algorithm to add additional <HR> linebreaks. This prevents ugly formatting.
  5. Allows for converting into AREA/STACK or LINE1 graphs
  6. Displays a list of Graph Items (taken from the first Graph selected) to allow for skipping selected graph items
  7. Allows for Totaling, either SIMILAR or ALL data sources
  8. Totaling only now supported
  9. Defines “Color Templates”. These define a list of colors, e.g. light red to dark red. Allows to associate colored Graph Items to a Color Template. By doing so, Graph Items of same data source will no longer show the same color but instead will be colorized according to the Color Template

Prerequisites

This plugin is now in the core of Cacti 1.x. If you wish to use version 1.10, please refer to the README in that archive version. It works fine with Cacti 0.8.8b and above.

Installation

Just like any other plugin, just copy into the plugins directory, install and enable.

Usage

This plugin adds a new dropdown action to Graph Management, called “Create Aggregate Graphs”. To use it, please filter the graphs you want to aggregate and select all of those you want to be aggregated. The topmost one serves as a “template” for the basic graph properties.

If you like to aggregate graphs of different type (e.g. a traffic graph and a graph showing the numbers of logged in users), no one will stop you doing so. But in case you want to interpret the data, this will be left to you. So, better aggregate graphs of same graph template.

Be aware: If the basic graphs include e.g. AREA/STACK graph items, those will overlap on the aggregate. Please select the option “Make it an AREA/STACK Graph”, and the plugin will take care for it. Alternatively, by checking “Make it a LINE1 Graph”, all AREA/STACKs are converted to LINE1. If the basic graphs include “Totals”, the aggregate will include those as well. It may not make that much sense to include several “Totals”; so you may want to delete some of them.

If the basic graph includes “COMMENTS”, you may want to delete some of them as well. This is supported by checking the “Skip” checkboxes for those Graph Items.

Graph templates may omit <HR> line breaks for the last graph item. You will want to provide those by checking the <HR> checkbox. This may come in useful as well when deleting special graph items in the middle of a graph templatre that carry a <HR>. If you skip those items, ugly formatting would be the result. To prevent this, mark the previous graph item with <HR>

In general, colors of graph items from different graphs will be equal. You will want to change colors to make the aggregate better readable.

This plugin supports re-colorization by means of “Color Templates”. Color Templates are a list of different colors. Selecting a Color Template for a colorized Graph Item from the dropdown selection list will associate this Graph Item with the color defined by the Color Template.

When aggregating, you will be prompted

  1. Title Format: Enter a new title for the Template.
  2. Graph Type: Select one of the following
    • Keep Graph Types - no changes to Graph Item Type
    • Make it an AREA/STACK Graph - create an AREA/STACK Graph
    • Make it a LINE1 Graph - convert to LINE1
  3. Graph Template Items
    • Select a given Color Template to change the color of a Graph Item
    • Select the ”<HR>” checkbox to set a linebreak for that graph item
    • Select the “Skip” checkbox to suppress this Graph Item for the Aggregate

Additional Help?

Possible Bugs?

  • Please refer to the README.md on GitHub

Screenshots

Videos

A walk through video for Aggregate 1.0 Beta by thewitness






Personal Tools