1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>Making Your Scripts Work With Cacti</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="The Cacti Manual"
HREF="index.html"><LINK
REL="UP"
TITLE="Data Input Methods"
HREF="data_input_methods.html"><LINK
REL="PREVIOUS"
TITLE="Data Input Methods"
HREF="data_input_methods.html"><LINK
REL="NEXT"
TITLE="Data Queries"
HREF="data_queries.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="manual.css"></HEAD
><BODY
CLASS="SECT1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>The Cacti Manual</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="data_input_methods.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 11. Data Input Methods</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="data_queries.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="SECT1"
><H1
CLASS="SECT1"
><A
NAME="MAKING_SCRIPTS_WORK_WITH_CACTI"
>Making Your Scripts Work With Cacti</A
></H1
><P
> The simplest way to extend Cacti's data gathering functionality is through external scripts. Cacti comes
with a number of scripts out of the box which are located in the <TT
CLASS="FILENAME"
>scripts/</TT
> directory.
These scripts are used by the data input methods that are present in a new installation of Cacti.
</P
><P
> To have Cacti call an external script to gather data you must create a new data input method, making sure
to specify <SPAN
CLASS="GUILABEL"
>Script/Command</SPAN
> for the <SPAN
CLASS="GUILABEL"
>Input Type</SPAN
> field. See the
previous section, <A
HREF="data_input_methods.html"
TARGET="_top"
>Creating a Data Input Method</A
> for more
information about how to create a data input method. To gather data using your data input method, Cacti
simply executes the shell command specified in the <SPAN
CLASS="GUILABEL"
>Input String</SPAN
> field. Because of
this, you can have Cacti run any shell command or call any script which can be written in almost any
language.
</P
><P
> What Cacti is concerned with is the output of the script. When you define your data input method, you are
required to define one or more output fields. The number of output fields that you define here is important
to your script's output. For a data input method with only one output field, your script should output its
value in the following format:
</P
><PRE
CLASS="SCREEN"
><KBD
CLASS="USERINPUT"
><value_1></KBD
></PRE
><P
> So if I wrote a script that outputs the number of running processes, its output might look like the
following:
</P
><DIV
CLASS="EXAMPLE"
><A
NAME="AEN1284"
></A
><P
><B
>Example 11-1. Example script output using 1 field</B
></P
><P
> <KBD
CLASS="USERINPUT"
>67</KBD
>
</P
></DIV
><P
> Data input methods with more than one output field are handled a bit differently when writing scripts.
Scripts that output more than one value should be formatted like the following:
</P
><PRE
CLASS="SCREEN"
><KBD
CLASS="USERINPUT"
><fieldname_1>:<value_1> <fieldname_2>:<value_2> ... <fieldname_n>:<value_n></KBD
></PRE
><P
> Lets say that I write a script that outputs the 1, 5, and 10 minute load average of a Unix machine. In Cacti,
I name the output fields '1min', '5min', and '10min', respectively. Based on these two things, the output of
the script should look like the following:
</P
><DIV
CLASS="EXAMPLE"
><A
NAME="AEN1292"
></A
><P
><B
>Example 11-2. Example script output using 3 fields</B
></P
><P
> <KBD
CLASS="USERINPUT"
>1min:0.40 5min:0.32 10min:0.01</KBD
>
</P
></DIV
><P
> One last thing to keep in mind when writing scripts for Cacti is that they will be executed as the user the
data gatherer runs as. Sometimes a script may work correctly when executed as root, but fails due to permissions
problems when executed as a less privileged user.
</P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="data_input_methods.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="index.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="data_queries.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>Data Input Methods</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="data_input_methods.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>Data Queries</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>
|
