Skip to content

Commit 4729db4

Browse files
committedMar 24, 2019
More spelling corruptions
1 parent 321907b commit 4729db4

16 files changed

+110
-110
lines changed
 

‎Data-Queries.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,10 @@ Field | Description
121121
--- | ---
122122
query->name | (Optional) You can enter a "friendly name" for the SNMP query here. It will not be used by Cacti, and is for identification only.
123123
query->description | (Optional) You can enter a description for the SNMP query here. It will not be used by Cacti, and is for identification only.
124-
query->oid_uptime | New with 0.8.7: If you have another OID that contains timetics, say for example a Java VM. Then, you can create a data query that specifies an alternate Uptime OID. To implement this for a data query, simply add the oid_uptime XML parameter to your XML file. Then, if you select your re-index method to be Uptime Goes Backward, Cacti will use that OID to detect whether it is time to re-index the host instead of the standard snmp OID for uptime.
124+
query->oid_uptime | New with 0.8.7: If you have another OID that contains ticks (time), say for example a Java VM. Then, you can create a data query that specifies an alternate uptime OID. To implement this for a data query, simply add the oid_uptime XML parameter to your XML file. Then, if you select your re-index method to be Uptime Goes Backward, Cacti will use that OID to detect whether it is time to re-index the host instead of the standard SNMP OID for uptime.
125125
query->oid_index | Every SNMP query must have an OID that represents the index values for the query when walked. As described above, any data query in Cacti must contain a field that uniquely identifies each row returned by the query. In the example above, the oid_index points to the OID of ifIndex in the interface MIB. Note: Starting with version 0.8.6c, Cacti is able to parse unique indexes from the OID itself. While the regular expression used for parsing the value from the OID is defined below, you must still specify an OID that can be walked by Cacti in order to obtain the list of OID's. Any OID defined for one of your input fields should work in this case. The values returned from the snmpwalk walk will be completely disregarded.
126126
query->oid_index_parse | This field should only be used if you are trying to parse the unique index from the OID itself. If this field is defined, to obtain a list of indexes, Cacti walks the OID provided in the oid_index field above. It then applies the regular expression provided in this field to the list of OID's that are returned. The matched substrings that remain become the list of indexes for this SNMP query.
127-
query->oid_num_indexes | An OID that can be queried to determine the total number of available indexes. If specified, this will be used to determine when to automatically recache this SNMP query when it is attached to a device.
127+
query->oid_num_indexes | An OID that can be queried to determine the total number of available indexes. If specified, this will be used to determine when to automatically re-cache this SNMP query when it is attached to a device.
128128
query->index_order | As of version 0.8.6, Cacti will attempt to find the best field to index off of based on whether each row in the query is unique and non-null. If specified, Cacti will perform this check on the fields listed here in the order specified. Only input fields can be specified and multiple fields should be delimited with a colon.
129129
query->index_order_type | For sorting purposes, specify whether the index is numeric or alphanumeric. numeric: The indexes in this SNMP query are to be sorted numerically (ie. 1,2,3,10,20,31) alphabetic: The indexes in this SNMP query are to be sorted alphabetically (1,10,2,20,3,31).
130130
query->index_title_format | Specify the title format to use when representing an index to the user. Any input field name can be used as a variable if enclosed in pipes (|). The variable `|chosen_order_field|` will be substituted with the field chosen by Cacti to index off of (see index_order above).
@@ -172,7 +172,7 @@ query->script_path | Enter the complete path to the script or executable that is
172172
query->arg_index | Enter the argument that is to be passed to the script to retrieve a list of indexes.
173173
query->arg_query | Enter the argument that is to be passed to the script to retrieve a list of values given a field name.
174174
query->arg_get | Enter the argument that is to be passed to the script to retrieve a single value given a field name and index value.
175-
query->arg_num_indexes | Enter the argument that is to be passed to the script to determine the total number of available indexes. If specified, this will be used to determine when to automatically recache this script query when it is attached to a device.
175+
query->arg_num_indexes | Enter the argument that is to be passed to the script to determine the total number of available indexes. If specified, this will be used to determine when to automatically re-cache this script query when it is attached to a device.
176176
query->output_delimeter | Enter the one character delimiter that will be used to separate output values. This is only used when you "query" the script in which case it outputs 'index(delimiter)value'.
177177
query->index_order | As of version 0.8.6, Cacti will attempt to find the best field to index off of based on whether each row in the query is unique and non-null. If specified, Cacti will perform this check on the fields listed here in the order specified. Only input fields can be specified and multiple fields should be delimited with a comma.
178178
query->index_order_type | For sorting purposes, specify whether the index is numeric or alphanumeric. numeric: The indexes in this script query are to be sorted numerically (ie. 1,2,3,10,20,31) alphabetic: The indexes in this script query are to be sorted alphabetically (1,10,2,20,3,31).

‎Debugging.md

+35-35
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,12 @@ change this, see `Settings`, `Poller` and lower the value for `The Maximum SNMP
1717
OID's Per SNMP Get Request`. Start at a value of 2 and increase it again, if
1818
the poller starts working. (1 or less disables snmpbulkwalk) Some agent's don't
1919
have the horsepower to deliver that many OID's at a time. Therefore, we can
20-
reduce the number for those older/underpowered devices.
20+
reduce the number for those older/under-powered devices.
2121

2222
## Check Basic Data Gathering
2323

24-
For scripts, run them as cactiuser from cli to check basic functionality. E.g.
25-
for a perl script named `your-perl-script.pl` with parameters "p1 p2" under
24+
For scripts, run them as cactiuser from CLI to check basic functionality. E.g.
25+
for a Perl script named `your-perl-script.pl` with parameters "p1 p2" under
2626
*nix this would look like:
2727

2828
```sh
@@ -31,8 +31,8 @@ su - cactiuser
3131
... (check output)
3232
```
3333

34-
For snmp, snmpget the _exact_ OID you're asking for, using same community
35-
string and snmp version as defined within cacti. For an OID of
34+
For SNMP, snmpget the _exact_ OID you're asking for, using same community
35+
string and SNMP version as defined within cacti. For an OID of
3636
`.1.3.6.1.4.something`, community string of `very-secret` and version 2 for
3737
target host `target-host` this would look like
3838

@@ -41,12 +41,12 @@ snmpget -c very-secret -v 2c target-host .1.3.6.1.4.something
4141
.... (check output)
4242
```
4343

44-
## Check cacti's poller
44+
## Check Cacti's poller
4545

4646
First make sure that crontab always shows poller.php. This program will either
47-
call cmd.php, the PHP based poller _or_ cactid, the fast alternative, written
48-
in C. Define the poller you're using at `Settings`, `Poller`. Cactid has to be
49-
implemented seperately, it does not come with cacti by default.
47+
call cmd.php, the PHP based poller _or_ spine, the fast alternative, written
48+
in C. Define the poller you're using at `Settings`, `Poller`. Spine has to be
49+
implemented separately, it does not come with cacti by default.
5050

5151
Now, clear `./log/cacti.log` (or rename it to get a fresh start)
5252

@@ -56,12 +56,12 @@ subsequent polling cycles.
5656

5757
Now, find the host/data source in question. The `Host[<id>]` is given
5858
numerically, the `<id>` being a specific number for that host. Find this `<id>`
59-
from the `Devices` menue when editing the host: The url contains a string like
59+
from the `Devices` menu when editing the host: The URL contains a string like
6060

6161
`id=<id>`
6262

6363
Check, whether the output is as expected. If not, check your script (e.g.
64-
`/full/path/to/perl`). If ok, proceed to next step
64+
`/full/path/to/perl`). If OK, proceed to next step
6565

6666
This procedure may be replaced by running the poller manually for the failing
6767
host only. To do so, you need the `<id>`, again. If you're using cmd.php, set the
@@ -71,13 +71,13 @@ DEBUG logging level as defined above and run
7171
php -q cmd.php <id> <id>
7272
```
7373

74-
If you're using cactid, you may override logging level when calling the poller:
74+
If you're using spine, you may override logging level when calling the poller:
7575

7676
```sh
77-
./cactid --verbosity=5 <id> <id>
77+
./spine --verbosity=5 <id> <id>
7878
```
7979

80-
All output is printed to STDOUT in both cases. This procdure allows for
80+
All output is printed to STDOUT in both cases. This procedure allows for
8181
repeated tests without waiting for the next polling interval. And there's no
8282
need to manually search for the failing host between hundreds of lines of
8383
output.
@@ -88,11 +88,11 @@ In most cases, this step can be skipped. You may want to return to this step if
8888
the next one fails (e.g. no rrdtool update to be found)
8989

9090
From debug log, find the MySQL update statement for that host concerning table
91-
`poller_output`. On very rare occasions, this will fail. Copy that sql
92-
statement and paste it to a mysql session started from cli. This may as well be
93-
done from some tool like phpMyAdmin. Check the sql return code.
91+
`poller_output`. On very rare occasions, this will fail. Copy that SQL
92+
statement and paste it to a mysql session started from CLI. This may as well be
93+
done from some tool like phpMyAdmin. Check the SQL return code.
9494

95-
## Check rrd file updating
95+
## Check RRD file updating
9696

9797
Down in the same log, you should find some
9898

@@ -106,9 +106,9 @@ RRD files should be created by the poller. If it does not create them, it will
106106
not fill them either. If it does check your `Poller Cache` from Utilities and
107107
search for your target. Does the query show up here?
108108

109-
## Check rrd file ownership
109+
## Check RRD file ownership
110110

111-
If rrd files were created e.g. with root ownership, a poller running as
111+
If RRD files were created e.g. with root ownership, a poller running as
112112
cactiuser will not be able to update those files
113113

114114
```sh
@@ -127,23 +127,23 @@ Run the following command to cure this problem
127127
chown cactiuser:cactiuser *.rrd
128128
```
129129

130-
## Check rrd file numbers
130+
## Check RRD file numbers
131131

132-
You're perhaps wondering about this step, if the former was ok. But due to data
132+
You're perhaps wondering about this step, if the former was OK. But due to data
133133
sources MINIMUM and MAXIMUM definitions, it is possible, that valid updates for
134-
rrd files are suppressed, because MINIMUM was not reached or MAXIMUM was
134+
RRD files are suppressed, because MINIMUM was not reached or MAXIMUM was
135135
exceeded.
136136

137137
Assuming, you've got some valid `rrdtool update` in step 3, perform a
138138

139139
```sh
140-
rrdtool fetch <rrd file> AVERAGE
140+
rrdtool fetch <RRD file> AVERAGE
141141
```
142142

143143
and look at the last 10-20 lines. If you find NaN's there, perform
144144

145145
```sh
146-
rrdtool info <rrd file>
146+
rrdtool info <RRD file>
147147
```
148148

149149
and check the `ds[...].min` and `ds[...].max` entries, e.g.
@@ -161,26 +161,26 @@ If you run into this, not only should you update the data source definition
161161
within the Data Template, but also perform a:
162162

163163
```sh
164-
rrdtool tune <rrd file> --maximum <ds-name>:<new ds maximum>
164+
rrdtool tune <RRD file> --maximum <ds-name>:<new ds maximum>
165165
```
166166

167-
for all existing rrd files belonging to that Data Template.
167+
for all existing RRD files belonging to that Data Template.
168168

169-
At this step, it is wise to check `step` and `heartbeat` of the rrd file as
169+
At this step, it is wise to check `step` and `heartbeat` of the RRD file as
170170
well. For standard 300 seconds polling intervals (step=300), it is wise to set
171171
`minimal_heartbeat` to 600 seconds. If a single update is missing and the next
172172
one occurs in less than 600 seconds from the last one, rrdtool will interpolate
173173
the missing update. Thus, gaps are "filled" automatically by interpolation. Be
174174
aware of the fact, that this is no "real" data! Again, this must be done in the
175-
Data Template itself and by using rrdtool tune for all existing rrd files of
175+
Data Template itself and by using rrdtool tune for all existing RRD files of
176176
this type.
177177

178178
## Check rrdtool graph statement
179179

180-
Last resort would be to check, that the correct data sources are used. Goto
180+
Last resort would be to check, that the correct data sources are used. Go to
181181
`Graph Management` and select your Graph. Enable DEBUG Mode to find the whole
182182
`rrdtool graph` statement. You should notice the `DEF` statements. They specify
183-
the rrd file and data source to be used. You may check, that all of them are as
183+
the RRD file and data source to be used. You may check, that all of them are as
184184
wanted.
185185

186186
## Miscellaneous
@@ -191,7 +191,7 @@ reasonable size.
191191
This is commonly due to php.ini's memory settings of 8MB default. Change this
192192
to at least 64 MB.
193193

194-
To check this, run the following sql from mysql cli (or phpmyadmin or the like)
194+
To check this, run the following SQL from mysql CLI (or phpmyadmin or the like)
195195

196196
```sql
197197
select count(*) from poller_output;
@@ -213,10 +213,10 @@ installation instructions to the letter (which you should always do ;-) ), you
213213
may now have two poller running. That's not a good thing, though. Most rpm
214214
installations will setup cron in `/etc/cron.d/cacti`
215215

216-
Now check all your crontabs, especially `/etc/crontab` and crontabs of users
216+
Now check all your crontab, especially `/etc/crontab` and crontab of users
217217
root and cactiuser. Leave only one poller entry for all of them. Personally,
218-
I've chosen `/etc/cron.d/cacti` to avoid problems when updating rpm's. Mosten
219-
often, you won't remember this item when updating lots of rpm's, so I felt more
218+
I've chosen `/etc/cron.d/cacti` to avoid problems when updating RPM's. Mosten
219+
often, you won't remember this item when updating lots of RPM's, so I felt more
220220
secure to put it here. And I've made some slight modifications, see
221221

222222
```sh

‎Frequently-Asked-Questions.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -66,7 +66,7 @@ mysql> update user_auth set password=md5('admin') where username='admin';
6666
to run.
6767

6868
**A:** Give Spine, the fast replacement for poller.php a try. Unlike
69-
poller.php, Spine is written in c and makes use of pthreads. On a typical
69+
poller.php, Spine is written in c and makes use of threads. On a typical
7070
installation, it is not uncommon for Spine to poll about 500 items in less then
7171
10 seconds.
7272

@@ -148,7 +148,7 @@ the Visual tab, and changing the value for Data Queries - Maximum Field Length.
148148

149149
**Q:** One of my devices rebooted and now I have a huge spike on my graph!
150150

151-
**A:** This occurs because the reboot causes SNMP's counters to reset, which
151+
**A:** This occurs because the reboot causes SNMP counters to reset, which
152152
can cause a rather large spike on the graph when RRDTool tries to determine the
153153
change between the new small counter value and the large previous value. One
154154
way to combat this issue is to specify realistic maximum values for your data

‎Graph-a-Single-SNMP-OID.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ Name | Description
2424
(Graph Items) Legend Text | The text that will be used to describe the data on the graph legend.
2525
(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.
2626
(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.
27-
(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 incrementing number, you should use COUNTER for this field. The two remaining field values, DERIVE and ABSOLUTE can be ignored in most situations.
27+
(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.
2828
(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.
2929

3030
You will be presented with several fields that will require input before the

‎Install-Under-CentOS_LAMP.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ files holding your certificate (`.crt`) and private key (`.key`).
2727

2828
```console
2929
#
30-
# Cacti: An rrd based graphing tool
30+
# Cacti: An RRD based graphing tool
3131
#
3232

3333
# For security reasons, the Cacti web interface is accessible only to
@@ -100,9 +100,9 @@ files holding your certificate (`.crt`) and private key (`.key`).
100100
The choice between MySQL server and MariaDB is normally down to the OS
101101
maintainers if you use one of the predefined LAMP setup installations. If you
102102
are deciding between these yourself, you should research this via your
103-
favourite search engine.
103+
favorite search engine.
104104

105-
Whilst MySQL is the original open source sql database server created in 1995
105+
Whilst MySQL is the original open source SQL database server created in 1995
106106
which is now owned by Oracle, MariaDB is designed as a drop-in replacement by
107107
some of the original MySQL developers / owners. This will likely continue to
108108
be a drop-in alternative until there is a major divergence that can not be
@@ -373,33 +373,33 @@ Make sure to setup the correct path to poller.php
373373

374374
### Security Enhanced Linux (SELinux)
375375

376-
If you are having issues to access the web page, disable selinux temporarily to
377-
prove that the issues come from the selinux policy. It is NOT recommended to
378-
disable SELINUX permanently.
376+
If you are having issues to access the web page, disable SELinux temporarily to
377+
prove that the issues come from the SELinux policy. It is NOT recommended to
378+
disable SELinux permanently.
379379

380380
[CentOS](https:////wiki.centos.org/es/HowTos/SELinux) has a lot of
381-
documentation on how to make your selinux policy right.
381+
documentation on how to make your SELinux policy right.
382382

383-
1. Check selinux status
383+
1. Check SELinux status
384384

385385
```console
386386
getenforce
387387
```
388388

389-
2. Disable selinux temporarily
389+
2. Disable SELinux temporarily
390390

391391
```console
392392
setenforce 0
393393
```
394394

395-
3. Enable selinux back
395+
3. Enable SELinux back
396396

397397
```console
398398
setenforce 1
399399
```
400400

401401
**Note:** If you installed Cacti out of `/var/www/html` make sure you fix up
402-
all selinux context and permissions.
402+
all SELinux context and permissions.
403403

404404
---
405405
Copyright (c) 2004-2019 The Cacti Group

0 commit comments

Comments
 (0)
Please sign in to comment.