-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy path01_features.html
399 lines (254 loc) · 13.3 KB
/
01_features.html
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
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
<!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>Keys features of RPi-Monitor — 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="Screenshots" href="02_screenshots.html" />
<link rel="prev" title="Welcome to RPi-Monitor documentation !" href="index.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 class="current">
<li class="toctree-l1 current"><a class="current reference internal" href="#">Keys features of RPi-Monitor</a><ul>
<li class="toctree-l2"><a class="reference internal" href="#collecting-metrics">Collecting metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="#storing-metrics">Storing metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="#presenting-collected-metrics">Presenting collected metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="#configurable">Configurable</a></li>
<li class="toctree-l2"><a class="reference internal" href="#processing-metrics-and-raising-alerts">Processing metrics and raising alerts</a></li>
<li class="toctree-l2"><a class="reference internal" href="#read-only-mode">Read only mode</a></li>
<li class="toctree-l2"><a class="reference internal" href="#sharing-metrics">Sharing metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="#extending-the-capabilities">Extending the capabilities</a></li>
<li class="toctree-l2"><a class="reference internal" href="#screenshots">Screenshots</a></li>
</ul>
</li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="10_index.html">Getting started</a></li>
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="20_index.html">Configuration</a></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>Keys features of RPi-Monitor</li>
<li class="wy-breadcrumbs-aside">
<!-- User defined GitHub URL -->
<a href="https://github.com/XavierBerger/RPi-Monitor/blob/develop/docs/source/01_features.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="keys-features-of-rpi-monitor">
<h1>Keys features of RPi-Monitor<a class="headerlink" href="#keys-features-of-rpi-monitor" title="Permalink to this headline">¶</a></h1>
<p>At the beginning <strong>RPi-Monitor</strong> was designed to run on <strong>Raspberry Pi</strong>. This
is explaining the name of this software. In reality <strong>RPi-Monitor</strong> can run
on every computers running <cite>perl</cite>.</p>
<div class="figure align-center">
<img alt="_images/logo.png" src="_images/logo.png" />
</div>
<p>Since the beginning <strong>RPi-Monitor</strong> as been designed for embedded devices and
performances is the core of development strategy.</p>
<p>The software is divided into two main part:</p>
<ul class="simple">
<li>A lightweight daemon running on the device and gathering data</li>
<li>A powerfull WEB application running in browser in charge of data rendering</li>
</ul>
<div class="figure align-center">
<a class="reference internal image-reference" href="_images/features001.png"><img alt="_images/features001.png" src="_images/features001.png" style="width: 500px;" /></a>
</div>
<div class="section" id="collecting-metrics">
<h2>Collecting metrics<a class="headerlink" href="#collecting-metrics" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><code class="docutils literal"><span class="pre">rpimonitord</span></code> is a daemon wich periodically gather, process and store metrics.
In <strong>RPi-Monitor</strong> metrics are named <strong>KPI</strong> for <strong>K</strong>ey <strong>P</strong>erformance <strong>I</strong>ndicator.</div></blockquote>
</div>
<div class="section" id="storing-metrics">
<h2>Storing metrics<a class="headerlink" href="#storing-metrics" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div>Metrics are stored into a <a class="reference external" href="https://oss.oetiker.ch/rrdtool/">Round Robin Database</a> (RRD).
This ensure a fixed size for the data storage and keep by default data over 1 year.</div></blockquote>
</div>
<div class="section" id="presenting-collected-metrics">
<h2>Presenting collected metrics<a class="headerlink" href="#presenting-collected-metrics" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p><strong>RPi-Monitor</strong> embed a web server designed to present collected metrics.
Instantaneous data are presented in the status page. Metrics stored in RRD
are presented in statistics pages.</p>
<p>The web interface allow user to reorganise status information by drag’n drop.</p>
<p>Statistics page allow to zoom over graph to see details of the mertics.</p>
<p>Embedded web server can be disable and pages can be served by an external web server.</p>
</div></blockquote>
</div>
<div class="section" id="configurable">
<h2>Configurable<a class="headerlink" href="#configurable" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p>In <strong>RPi-Monitor</strong> everything is configurable:</p>
<ul class="simple">
<li>Define what metrics to extract and how to extract them</li>
<li>Define how to store metrics</li>
<li>Define how to present and share metrics and statistics</li>
<li>Define how to detect an alert and what to do when alert appears or disappears</li>
<li>Define ... what you want to do with <strong>RPi-Monitor</strong></li>
</ul>
</div></blockquote>
</div>
<div class="section" id="processing-metrics-and-raising-alerts">
<h2>Processing metrics and raising alerts<a class="headerlink" href="#processing-metrics-and-raising-alerts" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p><strong>RPi-Monitor</strong> embed an alert engine fully configurable and able to determine
if metrics are out of expected range and raise alerts.</p>
<p>When an alert is detected, <strong>RPi-Monitor</strong> can execute an action. For example, sending email or SMS.</p>
<p>Definition of critera of alert detection as well as action to perform when alert
is detected are fully configurable.</p>
</div></blockquote>
</div>
<div class="section" id="read-only-mode">
<h2>Read only mode<a class="headerlink" href="#read-only-mode" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p>If writing data on disk/eMMC/SSD/SDCard/... is not possible, <strong>RPi-Monitor</strong>
can be executed in <strong>read-only</strong> mode.</p>
<p>Metrics can be retrived either by web interface in json format or through SNMP.</p>
</div></blockquote>
</div>
<div class="section" id="sharing-metrics">
<h2>Sharing metrics<a class="headerlink" href="#sharing-metrics" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div>Metrics collected can be downloaded in json format (using the embedded web
server), read on disk or remotely accessed through SNMP.</div></blockquote>
</div>
<div class="section" id="extending-the-capabilities">
<h2>Extending the capabilities<a class="headerlink" href="#extending-the-capabilities" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div><p><strong>RPi-Monitor</strong> is extensible. It provides addons allowing customisation of
the interface. For example: <a class="reference external" href="https://github.com/shellinabox/shellinabox">Shellinabox</a> or
<a class="reference external" href="https://github.com/ipartola/hawkeye">Hawkeye</a>.</p>
<p><strong>RPi-Monitor-Peeble</strong> allows to see monitoring status on <a class="reference external" href="https://www.pebble.com/">Peeble</a> smart watch.</p>
<p><strong>RPi-Monitor</strong> is also available for <a class="reference external" href="https://www.docker.com/">Docker</a> and for embedded devices created
with <a class="reference external" href="https://www.yoctoproject.org/">Yocto Project</a></p>
</div></blockquote>
</div>
<div class="section" id="screenshots">
<h2>Screenshots<a class="headerlink" href="#screenshots" title="Permalink to this headline">¶</a></h2>
<blockquote>
<div>See <a class="reference external" href="02_screenshots.html">screenshots</a> on dedicated page.</div></blockquote>
<div class="toctree-wrapper compound">
</div>
</div>
</div>
</div>
</div>
<footer>
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
<a href="02_screenshots.html" class="btn btn-neutral float-right" title="Screenshots" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
<a href="index.html" class="btn btn-neutral" title="Welcome to RPi-Monitor documentation !" 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>