Skip to content

Commit 337e8d0

Browse files
committed
Correct use of RRDtool and more
* Correct use of RRDtool * dos2unix on MD files * Update RRDtool-Specific-Features.md
1 parent d4fcd69 commit 337e8d0

28 files changed

+354
-274
lines changed

Boost.md

+197-197
Large diffs are not rendered by default.

Data-Collectors.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
Cacti can support from one to many **Data Collectors**. There are two types
66
of **Data Collectors** they are:
77

8-
- **Main Data Collector** - This is essentially your core Cacti server
8+
- **Main Data Collector** - This is essentially your core Cacti server
99
and database. The **Main Data Collector** is also referred to as
1010
the **Primary Server**.
1111
- **Remote Data Collector** - These Data Collectors are located in

Data-Input-Methods.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -193,7 +193,7 @@ close(PROCESS);
193193
$ping =~ m/(.*time=)(.*) (ms|usec)/;
194194

195195
if ($2 == "") {
196-
print "U"; # avoid cacti errors, but do not fake RRDTool stats
196+
print "U"; # avoid cacti errors, but do not fake RRDtool stats
197197
}elsif ($3 eq "usec") {
198198
print $2/1000; # re-calculate in units of "ms"
199199
}else{
@@ -299,7 +299,7 @@ more nice legends, see:
299299
![Graph Template Items 4](images/r-gt5.png)
300300
301301
Notice, that the **Data Source** is filled in automagically. Select LEGEND as
302-
**Graph Item Type** (it is not really a **Graph Item Type** in RRDTool-speak,
302+
**Graph Item Type** (it is not really a **Graph Item Type** in RRDtool-speak,
303303
but a nice time-saver), and click **Create** to see:
304304
305305
![Graph Template Items 5](images/r-gt6.png)
@@ -523,7 +523,7 @@ Finally Save and be proud!
523523
The previous step explained how to call the script that retrieves the data. Now
524524
it's time to tell Cacti, how to store them in RRD files. You will need a single
525525
**Data Template** only, even if two different output fields will be stored. RRD
526-
files are able to store more than one output fields; RRDTool's name for those is
526+
files are able to store more than one output fields; RRDtool's name for those is
527527
**Data Source**. So we will create
528528
529529
1. One single **Data Template** representing one RRDfile

Debugging.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ for all existing RRD files belonging to that Data Template.
172172
At this step, it is wise to check `step` and `heartbeat` of the RRD file as
173173
well. For standard 300 seconds polling intervals (step=300), it is wise to set
174174
`minimal_heartbeat` to 600 seconds. If a single update is missing and the next
175-
one occurs in less than 600 seconds from the last one, RRDTool will interpolate
175+
one occurs in less than 600 seconds from the last one, RRDtool will interpolate
176176
the missing update. Thus, gaps are "filled" automatically by interpolation. Be
177177
aware of the fact, that this is no "real" data! Again, this must be done in the
178178
Data Template itself and by using `rrdtool tune` for all existing RRD files of
@@ -231,7 +231,7 @@ shell> vi /etc/cron.d/cacti
231231
```
232232

233233
This will produce a file `/var/local/log/poller.log`, which includes some
234-
additional informations from each poller's run, such as RRDTool errors. It
234+
additional informations from each poller's run, such as RRDtool errors. It
235235
occupies only some few bytes and will be overwritten each time.
236236

237237
If you're using the crontab of user "cactiuser" instead, this will look like

Frequently-Asked-Questions.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ shell> ls -al rra/
169169

170170
If only some of your graphs are not updating correctly, double check the
171171
Maximum Value field for all data sources used by these graphs. If the value
172-
being fed to the .rrd file exceeds its Maximum Value, RRDTool will insert an
172+
being fed to the .rrd file exceeds its Maximum Value, RRDtool will insert an
173173
Unknown and you will see no data on the graph.
174174

175175
**Q:** A lot of my graphs contain long ifAlias names, but they are being
@@ -182,22 +182,22 @@ the Visual tab, and changing the value for Data Queries - Maximum Field Length.
182182
**Q:** One of my devices rebooted and now I have a huge spike on my graph!
183183

184184
**A:** This occurs because the reboot causes SNMP counters to reset, which
185-
can cause a rather large spike on the graph when RRDTool tries to determine the
185+
can cause a rather large spike on the graph when RRDtool tries to determine the
186186
change between the new small counter value and the large previous value. One
187187
way to combat this issue is to specify realistic maximum values for your data
188-
sources. RRDTool will ignore any value that is larger than the maximum value.
188+
sources. RRDtool will ignore any value that is larger than the maximum value.
189189

190190
If you already have a spike on one or more of your graphs, there is a really
191191
[useful Perl script](http://cricket.sourceforge.net/contrib/files/killspike2)
192192
that will remove them for you.
193193

194-
**Q:** RRDTool Says: ERROR: unknown option '--slope-mode' or RRDTool Says:
194+
**Q:** RRDtool Says: ERROR: unknown option '--slope-mode' or RRDtool Says:
195195
ERROR: Garbage ':39:24 To 2005/10/22 16:39:24\c' after command: COMMENT:From
196196
2005/10/21 16:39:24 To 2005/10/22 16:39:24\c
197197

198-
**A:** This occurs because the version of RRDTool that you are running does not
199-
match the RRDTool version Cacti is configured to use. Double check your Cacti
200-
Settings and make sure that the RRDTool version matches what version of RRDTool
198+
**A:** This occurs because the version of RRDtool that you are running does not
199+
match the RRDtool version Cacti is configured to use. Double check your Cacti
200+
Settings and make sure that the RRDtool version matches what version of RRDtool
201201
you are running.
202202

203203
## Windows Related

Graph-Overview.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ pick. While it is possible to manually create graphs through this interface,
66
new users should follow the instructions provided in the next chapter for
77
creating **New Graphs** in Cacti.
88

9-
For users who are familiar with [RRDTool](http://www.RRDTool.org/), you will
10-
immediately recognize that a **Graph** in Cacti is closely modeled after RRDTool's
9+
For users who are familiar with [RRDtool](http://www.RRDtool.org/), you will
10+
immediately recognize that a **Graph** in Cacti is closely modeled after RRDtool's
1111
graphs. This makes sense since Cacti provides a user friendly interface to
12-
RRDTool without requiring users to understand how RRDTool works. With this in
12+
RRDtool without requiring users to understand how RRDtool works. With this in
1313
mind, every **Graph** in Cacti has certain settings and at least one **Graph Item**
1414
associated with it. While graph settings define the overall properties of a
1515
**Graph**, the **Graph Items** define the data that is to be represented on the **Graph**.

Graph-Templates.md

+6-6
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Graph Templates
22

3-
**Graph Templates** are Cacti objects that allows you to define how RRDTool is
4-
to render a Cacti **Graph**. Most RRDTool options are supported including
3+
**Graph Templates** are Cacti objects that allows you to define how RRDtool is
4+
to render a Cacti **Graph**. Most RRDtool options are supported including
55
CDEF's and VDEF's, Left and Right Axis, Ticks and Dashes, multiple Auto Scaling,
66
Grid, and Legend Options.
77

@@ -47,8 +47,8 @@ Section | Description
4747
*Legend Options* | Defines how the Legends should be formatted
4848

4949
Each of these sections are displayed below for reference. For more information
50-
on how to use these options, please visit the [RRDTool
51-
Website](http://RRDTool.org).
50+
on how to use these options, please visit the [RRDtool
51+
Website](http://RRDtool.org).
5252

5353
The *Graph Items* make up what is draw within the canvas of the Graph. There
5454
are several *Graph Item* types including:
@@ -88,7 +88,7 @@ Mega integer Bytes - 1000). Lastly, the *Slope Mode* gives the resulting
8888

8989
The *Scaling Options* allow the Administrator to apply either *Rigid* or *Auto
9090
Scaling* settings to the resulting *Graph*. These options are fairly self
91-
explanatory. However, you can always view the RRDTool Documentation online for
91+
explanatory. However, you can always view the RRDtool Documentation online for
9292
more information.
9393

9494
![Scaling Options](images/graph-templates-edit3.png)
@@ -103,7 +103,7 @@ The *Axis Options* allow you to define a *Right Axis* and optional *Formatters*.
103103
![Axis Options](images/graph-templates-edit5.png)
104104

105105
The *Legend* options allow you to specify how the *Legend* should be placed on
106-
the resulting **Graph** modern RRDTool has several options that were not
106+
the resulting **Graph** modern RRDtool has several options that were not
107107
available in Cacti prior to Cacti 1.0.
108108

109109
![Legend Options](images/graph-templates-edit6.png)

Graph-a-Single-SNMP-OID.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -37,11 +37,11 @@ Name | Description
3737
(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.
3838
(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'.
3939
(Graph Items) Legend Color | The color that will be used to represent the data on the graph.
40-
(Graph Items) Opacity/Alpha Channel | This optionally provides an opacity (not available with RRDTool-1.0.x) for a colored item.
40+
(Graph Items) Opacity/Alpha Channel | This optionally provides an opacity (not available with RRDtool-1.0.x) for a colored item.
4141
(Graph Items) Legend Text | The text that will be used to describe the data on the graph legend.
4242
(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.
4343
(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.
44-
(Data Source) Data Source Type [snmp_oid] | How the data from the OID should be stored by RRDTool and interpreted on the graph. If the value of the OID represents the actual data, you should use GAUGE for this field. If the OID value is a constantly incremented number, you should use COUNTER for this field. The two remaining field values, DERIVE and ABSOLUTE can be ignored in most situations.
44+
(Data Source) Data Source Type [snmp_oid] | How the data from the OID should be stored by RRDtool and interpreted on the graph. If the value of the OID represents the actual data, you should use GAUGE for this field. If the OID value is a constantly incremented number, you should use COUNTER for this field. The two remaining field values, DERIVE and ABSOLUTE can be ignored in most situations.
4545
(Custom Data) OID | The actual SNMP OID to graph. It is typically a good idea to enter the number OID here as opposed to using MIB names. For instance, to get the number of open files on a Netware server, you would use ".1.3.6.1.4.1.23.2.28.2.7.0" as the OID.
4646

4747
So, based upon your specific OID that you are graphing, You will need

Install-Under-CentOS_LAMP.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ files holding your certificate (`.crt`) and private key (`.key`).
3535

3636
```console
3737
#
38-
# Cacti: An RRD based graphing tool
38+
# Cacti: An RRDtool based graphing web application
3939
#
4040

4141
# For security reasons, the Cacti web interface is accessible only to
@@ -75,7 +75,7 @@ files holding your certificate (`.crt`) and private key (`.key`).
7575
# Uncomment these if you use mod_security.
7676
# allow POST of application/x-www-form-urlencoded during install
7777
#SecRuleRemoveById 960010
78-
# permit the specification of the RRDTool paths during install
78+
# permit the specification of the RRDtool paths during install
7979
#SecRuleRemoveById 900011
8080
</Directory>
8181

@@ -259,13 +259,13 @@ PHP and various packages are all required by Cacti for successful operation
259259
date.timezone = Pacific/Auckland
260260
```
261261

262-
#### RRDTool
262+
#### RRDtool
263263

264-
RRDTool is required to store the data retrieved from devices in `.rra` files to
264+
RRDtool is required to store the data retrieved from devices in `.rra` files to
265265
produce the graphs which are shown within Cacti
266266

267267
```console
268-
yum install -y RRDTool
268+
yum install -y rrdtool
269269
```
270270

271271
#### SNMP

Install-Under-CentOS_LEMP.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -342,9 +342,9 @@ Note: **php-fpm** is only required if your Web Server is Nginx
342342
systemctl restart php-fpm
343343
```
344344

345-
### RRDTool
345+
### RRDtool
346346

347-
RRDTool is required to store the data retrieved from devices in `.rra` files to
347+
RRDtool is required to store the data retrieved from devices in `.rra` files to
348348
produce the graphs which are shown within Cacti
349349

350350
```console

Installing-Under-Windows.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Cacti yourself, please follow the instructions below.
1414
3. Spine - Install from the zip distribution into the `c:\cacti` directory.
1515
Make sure your `spine.conf.dist` is located in that directory as well.
1616

17-
4. RRDTool - Install from the Cacti website. Install it into the `c:\cacti`
17+
4. RRDtool - Install from the Cacti website. Install it into the `c:\cacti`
1818
directory.
1919

2020
5. PHP X - Install into the `c:php` folder. If you choose to install into
@@ -27,7 +27,7 @@ Cacti yourself, please follow the instructions below.
2727

2828
7. (Optional) Cygwin - Download and execute `setup.exe` from the Cygwin website.
2929
Keep the `setup.exe` file for later use. You will need Cygwin and its
30-
development packages for building RRDTool and spine.
30+
development packages for building RRDtool and spine.
3131

3232
8. (Optional) Net-SNMP - Install to the `c:net-snmp` directory. If you choose to
3333
use `c:\Program Files\net-snmp` you will have to use 8.3 filenames to
@@ -121,7 +121,7 @@ The following changes will be required regardless of your selected Webserver.
121121
net start w3svc
122122
```
123123

124-
## Cygwin Installation Steps for spine and RRDTool
124+
## Cygwin Installation Steps for spine and RRDtool
125125

126126
1. Installing a single instance of Cygwin, and using it for all applications
127127
that require it is recommended so you do not have different versions of the
@@ -178,7 +178,7 @@ The following changes will be required regardless of your selected Webserver.
178178
is updated from time to time, so it's recommended that you update it
179179
periodically.
180180

181-
## RRDTool Download and Installation Instructions
181+
## RRDtool Download and Installation Instructions
182182

183183
1. TBD
184184

@@ -286,7 +286,7 @@ The following changes will be required regardless of your selected Webserver.
286286

287287
`c:/php/php.exe`
288288

289-
- RRDTool Binary Path:
289+
- RRDtool Binary Path:
290290

291291
`c:/cacti/rrdtool.exe`
292292

Plugin-Development.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ For a simple plugin example, please review the gexport plugin.
111111

112112
Several JavaScript based HTML5 Charting packages have been included in Cacti in
113113
an effort to assist plugin developers who wish to use graphing API's in their
114-
plugins other than RRDTool.
114+
plugins other than RRDtool.
115115

116116
- [C3](http://c3js.org/)
117117
- [D3](https://d3js.org/)

Plugin-Hook-API-Ref.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -916,7 +916,7 @@ lib/export.php | 1.2.0-beta1 |
916916

917917
This hook allows you to specify additional options or change parameters
918918
regarding graph image rendering. Some of the parameters will be passed to
919-
RRDTool.
919+
RRDtool.
920920

921921
file | introduced | retired
922922
--- | :--- | :---

Plugin-Reference.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ directory as it prevents remote file browsing of your Cacti site.
3939
| MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
4040
| GNU General Public License for more details. |
4141
+-------------------------------------------------------------------------+
42-
| Cacti: The Complete RRDTool-based Graphing Solution |
42+
| Cacti: The Complete RRDtool-based Graphing Solution |
4343
+-------------------------------------------------------------------------+
4444
| This code is designed, written, and maintained by the Cacti Group. See |
4545
| about.php and/or the AUTHORS file for specific developer information. |

Principles-of-Operation.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ to scripts, script queries and more.
2222
## Data Storage
2323

2424
There are lots of different approaches for this task. Some may use an (SQL)
25-
database, others flat files. Cacti uses [RRDTool](http://www.RRDTool.org/) to
25+
database, others flat files. Cacti uses [RRDtool](http://www.RRDtool.org/) to
2626
store data.
2727

2828
RRD is the acronym for Round Robin Database. RRD is a system to store and
@@ -31,15 +31,15 @@ server load average). It stores the data in a very compact way that will not
3131
expand over time, and it can create beautiful graphs. This keeps storage
3232
requirements at bay.
3333

34-
Likewise, RRDTool will perform some specific tasks. It performs consolidation
35-
to combine raw data (a primary data point in RRDTool lingo) to consolidated
34+
Likewise, RRDtool will perform some specific tasks. It performs consolidation
35+
to combine raw data (a primary data point in RRDtool lingo) to consolidated
3636
data (a consolidated data point). This way, historical data is compressed to
37-
save space. RRDTool knows different consolidation functions: AVERAGE, MAXIMUM,
37+
save space. RRDtool knows different consolidation functions: AVERAGE, MAXIMUM,
3838
MINIMUM and LAST.
3939

4040
## Data Presentation
4141

42-
One of the most appreciated features of [RRDTool](http://www.RRDTool.org/) is
42+
One of the most appreciated features of [RRDtool](http://www.RRDtool.org/) is
4343
the built-in graphing function. This comes in useful when combining this with
4444
some commonly used webserver. Such, it is possible to access the graphs from
4545
merely any browser on any platform.

README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Cacti](images/logo.svg)
44

5-
Cacti is designed to be a complete graphing solution based on the RRDTool's
5+
Cacti is designed to be a complete graphing solution based on the RRDtool's
66
framework. Its goal is to make a network administrator's job easier by taking
77
care of all the necessary details necessary to create meaningful graphs.
88

@@ -22,7 +22,7 @@ Please see the official Cacti website for information, support, and updates.
2222

2323
## Thanks
2424

25-
A very special thanks to Tobi Oetiker, the creator of RRDTool and the very
25+
A very special thanks to Tobi Oetiker, the creator of RRDtool and the very
2626
popular MRTG. The users of Cacti - especially anyone who has taken the time to
2727
create a bug report, or otherwise help fix a Cacti related problem. Also
2828
to anyone who has contributed to supporting Cacti.
@@ -234,7 +234,7 @@ FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
234234

235235
3. [Replacement Variables](Variables.md)
236236

237-
4. [RRDTool Specific Features](RRDTool-Specific-Features.md)
237+
4. [RRDtool Specific Features](RRDtool-Specific-Features.md)
238238

239239
5. [RRDProxy Specific Features](RRDproxy.md)
240240

RRDproxy.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# rrdproxy
22

3-
Cacti RRD Proxy is a standalone proxy interface to Tobi Oetiker's great RRDTool.
3+
Cacti RRD Proxy is a standalone proxy interface to Tobi Oetiker's great RRDtool.
44

55
The main focus of this project is to allow the relocation of RRD files, data
66
replication, support of Cacti Boost and, if needed, the RRDcached daemon. It

0 commit comments

Comments
 (0)