-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy path23_configuration_helper.html
More file actions
361 lines (215 loc) · 13.3 KB
/
23_configuration_helper.html
File metadata and controls
361 lines (215 loc) · 13.3 KB
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
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Interactive Configuration Helper — RPi-Monitor v2.13-r0</title>
<link rel="shortcut icon" href="_static/favicon.ico"/>
<link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<link rel="next" title="Web interface configuration" href="24_web.html" />
<link rel="prev" title="Metrics extraction configuration" href="22_extraction.html" />
<script src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<script>
(adsbygoogle = window.adsbygoogle || []).push({
google_ad_client: "ca-pub-6853682829194266",
enable_page_level_ads: true
});
</script>
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-114314379-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-18642541-8');
</script>
<script src="_static/js/modernizr.min.js"></script>
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search">
<a href="index.html" class="icon icon-home"> RPi-Monitor
</a>
<div class="version">
2.13
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div>
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
<ul>
<li class="toctree-l1"><a class="reference internal" href="01_features.html">Keys features of RPi-Monitor</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="10_index.html">Getting started</a></li>
</ul>
<ul class="current">
<li class="toctree-l1 current"><a class="reference internal" href="20_index.html">Configuration</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="21_daemon.html">Daemon configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="22_extraction.html">Metrics extraction configuration</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Interactive Configuration Helper</a></li>
<li class="toctree-l2"><a class="reference internal" href="24_web.html">Web interface configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="25_addons.html">Addons configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="26_alert.html">Alert configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="27_configuration_templates.html">Configuration templates</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="30_index.html">Usages</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="40_index.html">To go further</a></li>
</ul>
<hr />
<div style="padding: 0;">
<script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
<ins class="adsbygoogle"
style="display:inline-block;width:300px;height:250px"
data-ad-client="ca-pub-6853682829194266"
data-ad-slot="2876944524"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
</div>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
<nav class="wy-nav-top" aria-label="top navigation">
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">RPi-Monitor</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="breadcrumbs navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html">Docs</a> »</li>
<li><a href="20_index.html">Configuration</a> »</li>
<li>Interactive Configuration Helper</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/XavierBerger/RPi-Monitor/blob/develop/docs/source/23_configuration_helper.rst" class="fa fa-github"> Edit on GitHub</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<div class="section" id="interactive-configuration-helper">
<h1>Interactive Configuration Helper<a class="headerlink" href="#interactive-configuration-helper" title="Permalink to this headline">¶</a></h1>
<p><strong>RPi-Monitor</strong> <cite>Interactive Configuration Helper</cite> is a tool embedded into
<code class="docutils literal"><span class="pre">rpimonitord</span></code> helping to create configuration files.</p>
<p>This example is detailling how to use it to monitor a ntfs volume.</p>
<p>First execute the following command:</p>
<p><code class="docutils literal"><span class="pre">rpimonitord</span> <span class="pre">-i</span></code></p>
<img alt="_images/helper001.png" src="_images/helper001.png" />
<p>Press <code class="docutils literal"><span class="pre">Enter</span></code></p>
<img alt="_images/helper002.png" src="_images/helper002.png" />
<p>Enter : <code class="docutils literal"><span class="pre">df</span> <span class="pre">-t</span> <span class="pre">ntfs</span></code></p>
<img alt="_images/helper003.png" src="_images/helper003.png" />
<p><strong>RPi-Monitor</strong> will tell you how it will process the source.
In our example, it will execute the command <code class="docutils literal"><span class="pre">df</span></code>.
If it is correct, press <code class="docutils literal"><span class="pre">Enter</span></code>, if not, enter <code class="docutils literal"><span class="pre">no</span></code> ( or <code class="docutils literal"><span class="pre">No</span></code> or <code class="docutils literal"><span class="pre">n</span></code> or <code class="docutils literal"><span class="pre">N</span></code> )
to go back to previous screen.</p>
<img alt="_images/helper004.png" src="_images/helper004.png" />
<p>RPi-Monitor show you the ouput of the command as defined as source. If the
output is the one expected press <code class="docutils literal"><span class="pre">Enter</span></code>, if not, <strong>RPi-Monitor</strong> will ask you
to define the source again.</p>
<img alt="_images/helper005.png" src="_images/helper005.png" />
<p>By default the regulare expression is <code class="docutils literal"><span class="pre">(.*)</span></code>. This will return all the
data given by the source.
In the following screen you will see how we will find the regular expression
extracting the available space of our ntfs drive step by step.</p>
<p>Step one, hit <code class="docutils literal"><span class="pre">Enter</span></code> to see what is given by the source by default.</p>
<img alt="_images/helper006.png" src="_images/helper006.png" />
<p>The output is not the one expected hit <code class="docutils literal"><span class="pre">Enter</span></code> to define a new Regular expression.
The data is located after <code class="docutils literal"><span class="pre">sda1</span></code>. Lets enter the following regular
expression: <code class="docutils literal"><span class="pre">sda1(.*)</span></code> to get what is after <code class="docutils literal"><span class="pre">sda1</span></code>.</p>
<img alt="_images/helper007.png" src="_images/helper007.png" />
<p>The output is not the one expected yet hit <code class="docutils literal"><span class="pre">Enter</span></code> to define a new regular expression.
The data is located after <code class="docutils literal"><span class="pre">sda1</span></code> after some spaces <code class="docutils literal"><span class="pre">\s+</span></code>, some numbers <code class="docutils literal"><span class="pre">\d+</span></code>,
some spaces <code class="docutils literal"><span class="pre">\s+</span></code>, some numbers <code class="docutils literal"><span class="pre">\d+</span></code>, some spaces`` s+`` and is composed of numbers <code class="docutils literal"><span class="pre">(\d+)</span></code>.
Enter then the following regulare expression: <code class="docutils literal"><span class="pre">sda1\s+\d+\s+\d+\s+(\d+)</span></code></p>
<img alt="_images/helper008.png" src="_images/helper008.png" />
<p>The result is now the one expected , enter <code class="docutils literal"><span class="pre">Yes</span></code> ( or <code class="docutils literal"><span class="pre">yes</span></code> or <code class="docutils literal"><span class="pre">Y</span></code> or <code class="docutils literal"><span class="pre">y</span></code> )</p>
<img alt="_images/helper009.png" src="_images/helper009.png" />
<p>We want the value in <code class="docutils literal"><span class="pre">MB</span></code> while is it given in <code class="docutils literal"><span class="pre">kB</span></code>. We then need to divide it by <code class="docutils literal"><span class="pre">1024</span></code>.
The formula is then: <code class="docutils literal"><span class="pre">$1/1024</span></code></p>
<img alt="_images/helper010.png" src="_images/helper010.png" />
<p>This is the expected value, enter <code class="docutils literal"><span class="pre">yes</span></code></p>
<img alt="_images/helper011.png" src="_images/helper011.png" />
<p>The value extracted is variable so <code class="docutils literal"><span class="pre">dynamic</span></code> so enter <code class="docutils literal"><span class="pre">No</span></code>.</p>
<img alt="_images/helper012.png" src="_images/helper012.png" />
<p><strong>RPi-Monitor</strong> gives you the template of configuration. You now have to copy it
into an existing configuration file or add a new file in
<code class="docutils literal"><span class="pre">/etc/rpimonitord/</span></code> directory or subdirectory. Update the text inside <code class="docutils literal"><span class="pre"><></span></code> to
define how data should be stored. Include this file in <code class="docutils literal"><span class="pre">data.conf</span></code>.</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>dynamic.1.name=storage2_available
dynamic.1.source=df -t ntfs
dynamic.1.regexp=sda1\s+\d+\s+\d+\s+(\d+)
dynamic.1.postprocess=$1/1024
dynamic.1.rrd=GAUGE
</pre></div>
</div>
<p>Once the configuration will be apply, restart <strong>RPi-Monitor</strong> with the command:</p>
<p><code class="docutils literal"><span class="pre">/etc/init.d/rpimonitor</span> <span class="pre">restart</span></code></p>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="24_web.html" class="btn btn-neutral float-right" title="Web interface configuration" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="22_extraction.html" class="btn btn-neutral" title="Metrics extraction configuration" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>
© Copyright 2018, Xavier Berger.
Last updated on Mar 18, 2018.
</p>
</div>
Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
<ins class="adsbygoogle"
style="display:block"
data-ad-client="ca-pub-6853682829194266"
data-ad-slot="2876944524"
data-ad-format="auto"></ins>
<script>
(adsbygoogle = window.adsbygoogle || []).push({});
</script>
</footer>
</div>
</div>
</section>
</div>
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT:'./',
VERSION:'',
LANGUAGE:'None',
COLLAPSE_INDEX:false,
FILE_SUFFIX:'.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: ''
};
</script>
<script type="text/javascript" src="_static/jquery.js"></script>
<script type="text/javascript" src="_static/underscore.js"></script>
<script type="text/javascript" src="_static/doctools.js"></script>
<script type="text/javascript" src="_static/js/theme.js"></script>
<script type="text/javascript">
jQuery(function () {
SphinxRtdTheme.Navigation.enableSticky();
});
</script>
</body>
</html>