You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: Data-Input-Methods.md
+5-5
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Data Input Methods
2
2
3
-
Data Input Methods allow Cacti to retrieve data to insert into RRDfiles based upon a mapping controlled by **Data Templates** and their corresponding **Data Sources**. These resulting **Data Templates** and **Data Sources** can then be used to create **Graph Templates** and **Graphs**. Cacti includes a number of build in **Data Input Methods** for **SNMP** data and for **Script**, **Script Server** and **SNMP Data Queries**.
3
+
Data Input Methods allow Cacti to retrieve data to insert into RRD files based upon a mapping controlled by **Data Templates** and their corresponding **Data Sources**. These resulting **Data Templates** and **Data Sources** can then be used to create **Graph Templates** and **Graphs**. Cacti includes a number of build in **Data Input Methods** for **SNMP** data and for **Script**, **Script Server** and **SNMP Data Queries**.
4
4
5
5
Outside of the built in **Data Input Methods**, the Cacti Administrator can create virtually any **Data Input Method** based upon a **Scripts**, or a PHP **Script Server** script. The **Script** based **Data Input Method** allows Cacti to virtually collect data from anywhere, though the built in **SNMP** and **Script Server** methods provide the greatest scalability in Cacti. Both **Data Queries**, and PHP **Script Server** topics will be covered in later sections of the documentation.
6
6
@@ -26,7 +26,7 @@ When you are finished filling in all necessary fields, click the Create button t
26
26
27
27
The `Input Fields` box is used to define any fields that require information from the user or from various data within the Cacti Database such as the hostname, ip address, host id, etc. Any input fields referenced to in the input string must be defined here.
28
28
29
-
The `Output Fields` box is used to define each field that you expect back from the script and will be eventually stored in both the database and RRDfiles.
29
+
The `Output Fields` box is used to define each field that you expect back from the script and will be eventually stored in both the database and RRD files.
30
30
31
31
*All **Data Input Methods** must have at least one output field defined*, but may have more than one depending on the type.
32
32
@@ -116,7 +116,7 @@ close(PROCESS);
116
116
$ping =~ m/(.*time=)(.*) (ms|usec)/;
117
117
118
118
if ($2 == "") {
119
-
print "U";# avoid cacti errors, but do not fake RRDtool stats
119
+
print "U";# avoid cacti errors, but do not fake RRDTool stats
120
120
}elsif ($3 eq "usec") {
121
121
print $2/1000;# re-calculate in units of "ms"
122
122
}else{
@@ -188,7 +188,7 @@ Notice, that not only an entry was made under **Graph Template Items**, but unde
188
188
189
189
190
190
191
-
Notice, that the **Data Source** is filled in automagically. Select LEGEND as **Graph Item Type** (it is not really a **Graph Item Type** in RRDtool-speak, but a nice time-saver), and click **Create** to see:
191
+
Notice, that the **Data Source** is filled in automagically. Select LEGEND as **Graph Item Type** (it is not really a **Graph Item Type** in RRDTool-speak, but a nice time-saver), and click **Create** to see:
192
192
193
193
194
194
@@ -374,7 +374,7 @@ Finally Save and be proud!
374
374
375
375
### The Data Template
376
376
377
-
The previous step explained how to call the script that retrieves the data. Now it's time to tell Cacti, how to store them in RRDfiles. You will need a single **Data Template** only, even if two different output fields will be stored. RRDfiles are able to store more than one output fields; RRDtools name for those is **Data Source**. So we will create
377
+
The previous step explained how to call the script that retrieves the data. Now it's time to tell Cacti, how to store them in RRD files. You will need a single **Data Template** only, even if two different output fields will be stored. RRD files are able to store more than one output fields; RRDTool's name for those is **Data Source**. So we will create
378
378
379
379
1. one single **Data Template** representing one RRDfile
Copy file name to clipboardexpand all lines: Graph-Templates.md
+4-4
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
# Graph Templates
2
2
3
-
**Graph Templates** are Cacti objects that allows you to define how RRDtool is to render a Cacti **Graph**. Most RRDtool options are supported including CDEF's and VDEF's, Left and Right Axis, Ticks and Dashes, multiple Auto Scaling, Grid, and Legend Options.
3
+
**Graph Templates** are Cacti objects that allows you to define how RRDTool is to render a Cacti **Graph**. Most RRDTool options are supported including CDEF's and VDEF's, Left and Right Axis, Ticks and Dashes, multiple Auto Scaling, Grid, and Legend Options.
4
4
5
5
The purpose of **Graph Templates** is to simplify the **Automation** process by pre-defining the layout of **Graphs** for various metrics that are to be monitored in Cacti. When used in Conjunction with Cacti's **Graph Rules**, you can automatically create just about any **Data Query** based **Graph** during Cacti's **Network Discovery** process.
6
6
@@ -28,7 +28,7 @@ When Editing a **Graph Template**, there will be several sections that will requ
28
28
-*Axis Options* - Defines if there should be a right Axis and how it should be formatted
29
29
-*Legend Options* - Defines how the Legends should be formatted
30
30
31
-
Each of these sections are displayed below for reference. For more information on how to use these options, please visit the [RRDtool Website](http://rrdtool.org).
31
+
Each of these sections are displayed below for reference. For more information on how to use these options, please visit the [RRDTool Website](http://RRDTool.org).
32
32
33
33
The *Graph Items* make up what is draw within the canvas of the Graph. There are several *Graph Item* types including:
34
34
@@ -56,7 +56,7 @@ Under the *Common Options*, you will create a template for the *Graph Name*, ass
56
56
57
57
58
58
59
-
The *Scaling Options* allow the Administrator to apply either *Rigid* or *Auto Scaling* settings to the resulting *Graph*. These options are fairly self explanatory. However, you can always view the RRDtool Documentation online for more information.
59
+
The *Scaling Options* allow the Administrator to apply either *Rigid* or *Auto Scaling* settings to the resulting *Graph*. These options are fairly self explanatory. However, you can always view the RRDTool Documentation online for more information.
@@ -68,7 +68,7 @@ The *Axis Options* allow you to define a *Right Axis* and optional *Formatters*.
68
68
69
69
70
70
71
-
The *Legend* options allow you to specify how the *Legend* should be placed on the resulting **Graph** modern RRDtool has several options that were not available in Cacti prior to Cacti 1.0.
71
+
The *Legend* options allow you to specify how the *Legend* should be placed on the resulting **Graph** modern RRDTool has several options that were not available in Cacti prior to Cacti 1.0.
Copy file name to clipboardexpand all lines: Graph-a-Single-SNMP-OID.md
+1-1
Original file line number
Diff line number
Diff line change
@@ -20,7 +20,7 @@ Name | Description
20
20
(Graph) Title | The title that is to be used for the new graph. It is generally a good idea to keep `|host_description|` in the title, as to make the graph easier to identify later.
21
21
(Graph) Vertical Label | The text that will be printed along the y-axis of the graph. It is generally used to describe units, such as 'bytes' or 'percent'.
22
22
(Graph Items) Legend Color | The color that will be used to represent the data on the graph.
23
-
(Graph Items) Opacity/Alpha Channel | This optionally provides an opacity (not available with rrdtool-1.0.x) for a colored item.
23
+
(Graph Items) Opacity/Alpha Channel | This optionally provides an opacity (not available with RRDTool-1.0.x) for a colored item.
24
24
(Graph Items) Legend Text | The text that will be used to describe the data on the graph legend.
25
25
(Data Source) Name | The title that is to be used for the new data source. It is generally a good idea to keep |host_description| in the title, as to make the data source easier to identify later.
26
26
(Data Source) Maximum Value [snmp_oid] | The maximum value that will be accepted from the OID. Make sure you choose a value that is reasonable for the data you are trying to graph because anything larger than the maximum will be ignored. If you are graphing a percentage, you should use '100' as the value should never exceed this.
Copy file name to clipboardexpand all lines: Plugin-Hook-API-Ref.md
+2-2
Original file line number
Diff line number
Diff line change
@@ -712,7 +712,7 @@ poller.php | 1.0.0 |
712
712
713
713
## poller\_output
714
714
715
-
This hook was designed specifically for the boost plug-in. However, it has found new life in many plugins making them much faster now. What this hook allows you to do is intercept the contents of the `poller_output` table before the data is deleted. This allows for things like threshold checking and other interesting actions such as checking for up/down events and the like. Previously, plugins were reliant on using things like RRDtool fetch to perform these actions. Now they can leverage the pollers output directly.
715
+
This hook was designed specifically for the boost plug-in. However, it has found new life in many plugins making them much faster now. What this hook allows you to do is intercept the contents of the `poller_output` table before the data is deleted. This allows for things like threshold checking and other interesting actions such as checking for up/down events and the like. Previously, plugins were reliant on using things like `rrdtool fetch` to perform these actions. Now they can leverage the pollers output directly.
This hook allows you to specify additional options or change parameters regarding graph image rendering. Some of the parameters will be passed to rrdtool.
756
+
This hook allows you to specify additional options or change parameters regarding graph image rendering. Some of the parameters will be passed to RRDTool.
Copy file name to clipboardexpand all lines: RRDTool-Specific-Features.md
+3-3
Original file line number
Diff line number
Diff line change
@@ -38,7 +38,7 @@ description of each CDEF item type.
38
38
39
39
Type | Description
40
40
--- | ---
41
-
Function | You can choose a CDEF function to use as the item. [The RRDTool graph manual](http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/doc/rrdgraph.en.html) describes the purpose of each CDEF function.
41
+
Function | You can choose a CDEF function to use as the item. [The RRDTool's graph manual](http://people.ee.ethz.ch/~oetiker/webtools/rrdtool/doc/rrdgraph.en.html) describes the purpose of each CDEF function.
42
42
Operator | Just your standard math operators, including modulo (%).
43
43
Special Data Source | A special data source is basically a flag to tell Cacti to do some special processing when it encounters this CDEF item. The "Current Graph Item Data Source" type basically inserts the name of the data source that is referenced by the graph item that references to this CDEF. Both of the "All Data Sources" types insert a summation of all data sources used on a graph.
44
44
Another CDEF | You can recursively use another CDEF within this CDEF.
0 commit comments