]> arthur.barton.de Git - netdata.git/blob - web/dashboard_info.js
improved dashboard information about web_log charts
[netdata.git] / web / dashboard_info.js
1
2 var netdataDashboard = window.netdataDashboard || {};
3
4 // ----------------------------------------------------------------------------
5 // menus
6
7 // information about the main menus
8
9 netdataDashboard.menu = {
10     'system': {
11         title: 'System Overview',
12         icon: '<i class="fa fa-bookmark" aria-hidden="true"></i>',
13         info: 'Overview of the key system metrics.'
14     },
15
16     'services': {
17         title: 'systemd Services',
18         icon: '<i class="fa fa-cogs" aria-hidden="true"></i>',
19         info: 'Resources utilization of systemd services. netdata monitors all systemd services via cgroups (the resources accounting used by containers). '
20     },
21
22     'ap': {
23         title: 'Access Points',
24         icon: '<i class="fa fa-wifi" aria-hidden="true"></i>',
25         info: 'Performance metrics for the access points (i.e. wireless interfaces in AP mode) found on the system.'
26     },
27
28     'tc': {
29         title: 'Quality of Service',
30         icon: '<i class="fa fa-globe" aria-hidden="true"></i>',
31         info: 'Netdata collects and visualizes <code>tc</code> class utilization using its <a href="https://github.com/firehol/netdata/blob/master/plugins.d/tc-qos-helper.sh" target="_blank">tc-helper plugin</a>. If you also use <a href="http://firehol.org/#fireqos" target="_blank">FireQOS</a> for setting up QoS, netdata automatically collects interface and class names. If your QoS configuration includes overheads calculation, the values shown here will include these overheads (the total bandwidth for the same interface as reported in the Network Interfaces section, will be lower than the total bandwidth reported here). QoS data collection may have a slight time difference compared to the interface (QoS data collection uses a BASH script, so a shift in data collection of a few milliseconds should be justified).'
32     },
33
34     'net': {
35         title: 'Network Interfaces',
36         icon: '<i class="fa fa-share-alt" aria-hidden="true"></i>',
37         info: 'Performance metrics for network interfaces.'
38     },
39
40     'ipv4': {
41         title: 'IPv4 Networking',
42         icon: '<i class="fa fa-cloud" aria-hidden="true"></i>',
43         info: 'Metrics for the IPv4 stack of the system. <a href="https://en.wikipedia.org/wiki/IPv4" target="_blank">Internet Protocol version 4 (IPv4)</a> is the fourth version of the Internet Protocol (IP). It is one of the core protocols of standards-based internetworking methods in the Internet. IPv4 is a connectionless protocol for use on packet-switched networks. It operates on a best effort delivery model, in that it does not guarantee delivery, nor does it assure proper sequencing or avoidance of duplicate delivery. These aspects, including data integrity, are addressed by an upper layer transport protocol, such as the Transmission Control Protocol (TCP).'
44     },
45
46     'ipv6': {
47         title: 'IPv6 Networking',
48         icon: '<i class="fa fa-cloud" aria-hidden="true"></i>',
49         info: 'Metrics for the IPv6 stack of the system. <a href="https://en.wikipedia.org/wiki/IPv6" target="_blank">Internet Protocol version 6 (IPv6)</a> is the most recent version of the Internet Protocol (IP), the communications protocol that provides an identification and location system for computers on networks and routes traffic across the Internet. IPv6 was developed by the Internet Engineering Task Force (IETF) to deal with the long-anticipated problem of IPv4 address exhaustion. IPv6 is intended to replace IPv4.'
50     },
51
52     'ipvs': {
53         title: 'IP Virtual Server',
54         icon: '<i class="fa fa-eye" aria-hidden="true"></i>',
55         info: '<a href="http://www.linuxvirtualserver.org/software/ipvs.html" target="_blank">IPVS (IP Virtual Server)</a> implements transport-layer load balancing inside the Linux kernel, so called Layer-4 switching. IPVS running on a host acts as a load balancer at the front of a cluster of real servers, it can direct requests for TCP/UDP based services to the real servers, and makes services of the real servers to appear as a virtual service on a single IP address.'
56     },
57
58     'netfilter': {
59         title: 'Firewall (netfilter)',
60         icon: '<i class="fa fa-shield" aria-hidden="true"></i>',
61         info: 'Performance metrics of the netfilter components.'
62     },
63
64     'cpu': {
65         title: 'CPUs',
66         icon: '<i class="fa fa-bolt" aria-hidden="true"></i>',
67         info: 'Detailed information for each CPU of the system. A summary of the system for all CPUs can be found at the <a href="#menu_system">System Overview</a> section.'
68     },
69
70     'mem': {
71         title: 'Memory',
72         icon: '<i class="fa fa-bolt" aria-hidden="true"></i>',
73         info: 'Detailed information about the memory management of the system.'
74     },
75
76     'disk': {
77         title: 'Disks',
78         icon: '<i class="fa fa-folder" aria-hidden="true"></i>',
79         info: 'Charts with performance information for all the system disks. Special care has been given to present disk performance metrics in a way compatible with <code>iostat -x</code>. netdata by default prevents rendering performance charts for individual partitions and unmounted virtual disks. Disabled charts can still be enabled by configuring the relative settings in the netdata configuration file.'
80     },
81
82     'sensors': {
83         title: 'Sensors',
84         icon: '<i class="fa fa-leaf" aria-hidden="true"></i>',
85         info: 'Readings of the configured system sensors.'
86     },
87
88     'nfsd': {
89         title: 'NFS Server',
90         icon: '<i class="fa fa-folder-open" aria-hidden="true"></i>',
91         info: 'Performance metrics of the Network File Server. NFS is a distributed file system protocol, allowing a user on a client computer to access files over a network, much like local storage is accessed. NFS, like many other protocols, builds on the Open Network Computing Remote Procedure Call (ONC RPC) system. The NFS is an open standard defined in Request for Comments (RFC).'
92     },
93
94     'nfs': {
95         title: 'NFS Client',
96         icon: '<i class="fa fa-folder-open" aria-hidden="true"></i>',
97         info: 'Performance metrics of the NFS operations of this system, acting as an NFS client.'
98     },
99
100     'apps': {
101         title: 'Applications',
102         icon: '<i class="fa fa-heartbeat" aria-hidden="true"></i>',
103         info: 'Per application statistics are collected using netdata\'s <code>apps.plugin</code>. This plugin walks through all processes and aggregates statistics for applications of interest, defined in <code>/etc/netdata/apps_groups.conf</code> (the default is <a href="https://github.com/firehol/netdata/blob/master/conf.d/apps_groups.conf" target="_blank">here</a>). The plugin internally builds a process tree (much like <code>ps fax</code> does), and groups processes together (evaluating both child and parent processes) so that the result is always a chart with a predefined set of dimensions (of course, only application groups found running are reported). The reported values are compatible with <code>top</code>, although the netdata plugin counts also the resources of exited children (unlike <code>top</code> which shows only the resources of the currently running processes). So for processes like shell scripts, the reported values include the resources used by the commands these scripts run within each timeframe.',
104         height: 1.5
105     },
106
107     'users': {
108         title: 'Users',
109         icon: '<i class="fa fa-user" aria-hidden="true"></i>',
110         info: 'Per user statistics are collected using netdata\'s <code>apps.plugin</code>. This plugin walks through all processes and aggregates statistics per user. The reported values are compatible with <code>top</code>, although the netdata plugin counts also the resources of exited children (unlike <code>top</code> which shows only the resources of the currently running processes). So for processes like shell scripts, the reported values include the resources used by the commands these scripts run within each timeframe.',
111         height: 1.5
112     },
113
114     'groups': {
115         title: 'User Groups',
116         icon: '<i class="fa fa-users" aria-hidden="true"></i>',
117         info: 'Per user group statistics are collected using netdata\'s <code>apps.plugin</code>. This plugin walks through all processes and aggregates statistics per user group. The reported values are compatible with <code>top</code>, although the netdata plugin counts also the resources of exited children (unlike <code>top</code> which shows only the resources of the currently running processes). So for processes like shell scripts, the reported values include the resources used by the commands these scripts run within each timeframe.',
118         height: 1.5
119     },
120
121     'netdata': {
122         title: 'Netdata Monitoring',
123         icon: '<i class="fa fa-bar-chart" aria-hidden="true"></i>',
124         info: 'Performance metrics for the operation of netdata itself and its plugins.'
125     },
126
127     'example': {
128         title: 'Example Charts',
129         info: 'Example charts, demonstrating the external plugin architecture.'
130     },
131
132     'cgroup': {
133         title: '',
134         icon: '<i class="fa fa-th" aria-hidden="true"></i>',
135         info: 'Container resource utilization metrics. Netdata reads this information from <b>cgroups</b> (abbreviated from <b>control groups</b>), a Linux kernel feature that limits and accounts resource usage (CPU, memory, disk I/O, network, etc.) of a collection of processes. <b>cgroups</b> together with <b>namespaces</b> (that offer isolation between processes) provide what we usually call: <b>containers</b>.'
136     },
137
138     'cgqemu': {
139         title: '',
140         icon: '<i class="fa fa-th-large" aria-hidden="true"></i>',
141         info: 'QEMU virtual machine resource utilization metrics. QEMU (short for Quick Emulator) is a free and open-source hosted hypervisor that performs hardware virtualization.'
142     },
143
144     'fping': {
145         title: 'fping',
146         icon: '<i class="fa fa-exchange" aria-hidden="true"></i>',
147         info: 'Network latency statistics, via <b>fping</b>. <b>fping</b> is a program to send ICMP echo probes to network hosts, similar to <code>ping</code>, but much better performing when pinging multiple hosts. fping versions after 3.15 can be directly used as netdata plugins.'
148     },
149
150     'memcached': {
151         title: 'memcached',
152         icon: '<i class="fa fa-database" aria-hidden="true"></i>',
153         info: 'Performance metrics for <b>memcached</b>. Memcached is a general-purpose distributed memory caching system. It is often used to speed up dynamic database-driven websites by caching data and objects in RAM to reduce the number of times an external data source (such as a database or API) must be read.'
154     },
155
156     'mysql': {
157         title: 'MySQL',
158         icon: '<i class="fa fa-database" aria-hidden="true"></i>',
159         info: 'Performance metrics for <b>mysql</b>, the open-source relational database management system (RDBMS).'
160     },
161
162     'postgres': {
163         title: 'Postgres',
164         icon: '<i class="fa fa-database" aria-hidden="true"></i>',
165         info: 'Performance metrics for <b>PostgresSQL</b>, the object-relational database (ORDBMS).'
166     },
167
168     'redis': {
169         title: 'Redis',
170         icon: '<i class="fa fa-database" aria-hidden="true"></i>',
171         info: 'Performance metrics for <b>redis</b>. Redis (REmote DIctionary Server) is a software project that implements data structure servers. It is open-source, networked, in-memory, and stores keys with optional durability.'
172     },
173
174     'retroshare': {
175         title: 'RetroShare',
176         icon: '<i class="fa fa-share-alt" aria-hidden="true"></i>',
177         info: 'Performance metrics for <b>RetroShare</b>. RetroShare is open source software for encrypted filesharing, serverless email, instant messaging, online chat, and BBS, based on a friend-to-friend network built on GNU Privacy Guard (GPG).'
178     },
179
180     'ipfs': {
181         title: 'IPFS',
182         icon: '<i class="fa fa-folder-open" aria-hidden="true"></i>',
183         info: 'Performance metrics for the InterPlanetary File System (IPFS), a content-addressable, peer-to-peer hypermedia distribution protocol.'
184     },
185
186     'phpfpm': {
187         title: 'PHP-FPM',
188         icon: '<i class="fa fa-eye" aria-hidden="true"></i>',
189         info: 'Performance metrics for <b>PHP-FPM</b>, an alternative FastCGI implementation for PHP.'
190     },
191
192     'postfix': {
193         title: 'postfix',
194         icon: '<i class="fa fa-envelope" aria-hidden="true"></i>',
195         info: undefined
196     },
197
198     'dovecot': {
199         title: 'Dovecot',
200         icon: '<i class="fa fa-envelope" aria-hidden="true"></i>',
201         info: undefined
202     },
203
204     'hddtemp': {
205         title: 'HDD Temp',
206         icon: '<i class="fa fa-thermometer-full" aria-hidden="true"></i>',
207         info: undefined
208     },
209
210     'nginx': {
211         title: 'nginx',
212         icon: '<i class="fa fa-eye" aria-hidden="true"></i>',
213         info: undefined
214     },
215
216     'apache': {
217         title: 'Apache',
218         icon: '<i class="fa fa-eye" aria-hidden="true"></i>',
219         info: undefined
220     },
221
222     'web_log': {
223         title: undefined,
224         icon: '<i class="fa fa-file-text-o" aria-hidden="true"></i>',
225         info: 'Information extracted from a web server log file. <code>python.d/web_log</code> plugin incrementally parses the web server log file to provide, in real-time, a break down of key web server performance metrics. A special log file format may optionally be used (for <code>nginx</code> and <code>apache</code>) allowing the plugin to extract timing information for the web server responses and bandwidth for both requests and responses. <code>web_log</code> plugin may also be configured to provide a break down of requests per URL pattern (check <a href="https://github.com/firehol/netdata/blob/master/conf.d/python.d/web_log.conf" target="_blank"><code>/etc/netdata/python.d/web_log.conf</code></a>). netdata attaches several alarms on these charts, such as <b>too many bad requests</b>, <b>too many redirects</b>, <b>too many internal errors</b>, <b>unreasonably slow responses</b>, <b>unreasonably many requests</b> (i.e. web attack) and <b>unreasonably few requests</b> (i.e. something is wrong).'
226     },
227
228     'named': {
229         title: 'named',
230         icon: '<i class="fa fa-tag" aria-hidden="true"></i>',
231         info: undefined
232     },
233
234     'squid': {
235         title: 'squid',
236         icon: '<i class="fa fa-exchange" aria-hidden="true"></i>',
237         info: undefined
238     },
239
240     'nut': {
241         title: 'UPS',
242         icon: '<i class="fa fa-battery-half" aria-hidden="true"></i>',
243         info: undefined
244     },
245
246     'apcupsd': {
247         title: 'UPS',
248         icon: '<i class="fa fa-battery-half" aria-hidden="true"></i>',
249         info: undefined
250     },
251
252     'smawebbox': {
253         title: 'Solar Power',
254         icon: '<i class="fa fa-sun-o" aria-hidden="true"></i>',
255         info: undefined
256     },
257
258     'snmp': {
259         title: 'SNMP',
260         icon: '<i class="fa fa-random" aria-hidden="true"></i>',
261         info: undefined
262     }
263 };
264
265
266
267 // ----------------------------------------------------------------------------
268 // submenus
269
270 // information to be shown, just below each submenu
271
272 // information about the submenus
273 netdataDashboard.submenu = {
274     'web_log.bandwidth': {
275         info: 'Bandwidth of requests (<code>received</code>) and responses (<code>sent</code>). <code>received</code> requires a special file format (without it, the web server log does not have this information). This chart may present unusual spikes, since the whole bandwidth will be accounted at the time the log line is saved by the web server, even if the time needed to serve it spans across a longer duration. We suggest to use QoS (e.g. <a href="http://firehol.org/#fireqos" target="_blank">FireQOS</a>) for accurate accounting of the web server bandwidth.'
276     },
277
278     'web_log.urls': {
279         info: 'Number of requests for each URL <code>category</code> (URL pattern) defined in <a href="https://github.com/firehol/netdata/blob/master/conf.d/python.d/web_log.conf" target="_blank"><code>/etc/netdata/python.d/web_log.conf</code></a>. This chart counts all requests matching the URL patterns defined, independently of the web server response codes (i.e. both successful and unsuccessful).'
280     },
281
282     'web_log.clients': {
283         info: 'Charts showing the number of unique client IPs, accessing the web server.'
284     },
285
286     'web_log.timings': {
287         info: 'Web server response timings - the time the web server needed to prepare and respond to requests. This requires a special log format and its meaning is web server specific. For most web servers this accounts the time from the reception of a complete request, to the dispatch of the last byte of the response. So, it includes the network delays of responses, but it does not include the network delays of requests.'
288     },
289
290     'mem.ksm': {
291         title: 'Memory Deduper',
292         info: 'Kernel Same-page Merging (KSM) performance monitoring, read from several files in <code>/sys/kernel/mm/ksm/</code>. KSM is a memory-saving de-duplication feature in the Linux kernel (since version 2.6.32). The KSM daemon ksmd periodically scans those areas of user memory which have been registered with it, looking for pages of identical content which can be replaced by a single write-protected page (which is automatically copied if a process later wants to update its content). KSM was originally developed for use with KVM (where it was known as Kernel Shared Memory), to fit more virtual machines into physical memory, by sharing the data common between them.  But it can be useful to any application which generates many instances of the same data.'
293     },
294
295     'mem.numa': {
296         info: 'Non-Uniform Memory Access (NUMA) is a hierarchical memory design the memory access time is dependent on locality. Under NUMA, a processor can access its own local memory faster than non-local memory (memory local to another processor or memory shared between processors). The individual metrics are described in the <a href="https://www.kernel.org/doc/Documentation/numastat.txt" target="_blank">Linux kernel documentation</a>.'
297     },
298
299     'ipv4.ecn': {
300         info: '<a href="https://en.wikipedia.org/wiki/Explicit_Congestion_Notification" target="_blank">Explicit Congestion Notification (ECN)</a> is a TCP extension that allows end-to-end notification of network congestion without dropping packets. ECN is an optional feature that may be used between two ECN-enabled endpoints when the underlying network infrastructure also supports it.'
301     },
302
303     'netfilter.conntrack': {
304         title: 'Connection Tracker',
305         info: 'Netfilter Connection Tracker performance metrics. The connection tracker keeps track of all connections of the machine, inbound and outbound. It works by keeping a database with all open connections, tracking network and address translation and connection expectations.'
306     },
307
308     'netfilter.nfacct': {
309         title: 'Bandwidth Accounting',
310         info: 'The following information is read using the <code>nfacct.plugin</code>.'
311     },
312
313     'netfilter.synproxy': {
314         title: 'DDoS Protection',
315         info: 'DDoS protection performance metrics. <a href="https://github.com/firehol/firehol/wiki/Working-with-SYNPROXY" target="_blank">SYNPROXY</a> is a TCP SYN packets proxy. It is used to protect any TCP server (like a web server) from SYN floods and similar DDoS attacks. It is a netfilter module, in the Linux kernel (since version 3.12). It is optimized to handle millions of packets per second utilizing all CPUs available without any concurrency locking between the connections. It can be used for any kind of TCP traffic (even encrypted), since it does not interfere with the content itself.'
316     },
317
318     'system.softnet_stat': {
319         title: 'softnet',
320         info: function(os) {
321             if(os === 'linux')
322                 return 'Statistics for CPUs SoftIRQs related to network receive work. Break down per CPU core can be found at <a href="#menu_cpu_submenu_softnet_stat">CPU / softnet statistics</a>. <b>processed</b> states the number of packets processed, <b>dropped</b> is the number packets dropped because the network device backlog was full (to fix them on Linux use <code>sysctl</code> to increase <code>net.core.netdev_max_backlog</code>), <b>squeezed</b> is the number of packets dropped because the network device budget ran out (to fix them on Linux use <code>sysctl</code> to increase <code>net.core.netdev_budget</code>). More information about identifying and troubleshooting network driver related issues can be found at <a href="https://access.redhat.com/sites/default/files/attachments/20150325_network_performance_tuning.pdf" target="_blank">Red Hat Enterprise Linux Network Performance Tuning Guide</a>.';
323             else
324                 return 'Statistics for CPUs SoftIRQs related to network receive work.';
325         }
326     },
327
328     'cpu.softnet_stat': {
329         title: 'softnet',
330         info: function(os) {
331             if(os === 'linux')
332                 return 'Statistics for per CPUs core SoftIRQs related to network receive work. Total for all CPU cores can be found at <a href="#menu_system_submenu_softnet_stat">System / softnet statistics</a>. <b>processed</b> states the number of packets processed, <b>dropped</b> is the number packets dropped because the network device backlog was full (to fix them on Linux use <code>sysctl</code> to increase <code>net.core.netdev_max_backlog</code>), <b>squeezed</b> is the number of packets dropped because the network device budget ran out (to fix them on Linux use <code>sysctl</code> to increase <code>net.core.netdev_budget</code>). More information about identifying and troubleshooting network driver related issues can be found at <a href="https://access.redhat.com/sites/default/files/attachments/20150325_network_performance_tuning.pdf" target="_blank">Red Hat Enterprise Linux Network Performance Tuning Guide</a>.';
333             else
334                 return 'Statistics for per CPUs core SoftIRQs related to network receive work. Total for all CPU cores can be found at <a href="#menu_system_submenu_softnet_stat">System / softnet statistics</a>.';
335         }
336     }
337 };
338
339
340
341 // ----------------------------------------------------------------------------
342 // chart
343
344 // information works on the context of a chart
345 // Its purpose is to set:
346 //
347 // info: the text above the charts
348 // heads: the representation of the chart at the top the subsection (second level menu)
349 // mainheads: the representation of the chart at the top of the section (first level menu)
350 // colors: the dimension colors of the chart (the default colors are appended)
351 // height: the ratio of the chart height relative to the default
352 //
353 netdataDashboard.context = {
354     'system.cpu': {
355         info: function(os) {
356             void(os);
357             return 'Total CPU utilization (all cores). 100% here means there is no CPU idle time at all. You can get per core usage at the <a href="#menu_cpu">CPUs</a> section and per application usage at the <a href="#menu_apps">Applications Monitoring</a> section.'
358                 + netdataDashboard.sparkline('<br/>Keep an eye on <b>iowait</b> ', 'system.cpu', 'iowait', '%', '. If it is constantly high, your disks are a bottleneck and they slow your system down.')
359                 + netdataDashboard.sparkline('<br/>An important metric worth monitoring, is <b>softirq</b> ', 'system.cpu', 'softirq', '%', '. A constantly high percentage of softirq may indicate network driver issues.');
360         },
361         valueRange: "[0, 100]"
362     },
363
364     'system.load': {
365         info: 'Current system load, i.e. the number of processes using CPU or waiting for system resources (usually CPU and disk). The 3 metrics refer to 1, 5 and 15 minute averages. The system calculates this once every 5 seconds. For more information check <a href="https://en.wikipedia.org/wiki/Load_(computing)" target="_blank">this wikipedia article</a>',
366         height: 0.7
367     },
368
369     'system.io': {
370         info: 'Total Disk I/O, for all disks. You can get detailed information about each disk at the <a href="#menu_disk">Disks</a> section and per application Disk usage at the <a href="#menu_apps">Applications Monitoring</a> section.'
371     },
372
373     'system.swapio': {
374         info: 'Total Swap I/O. (netdata measures both <code>in</code> and <code>out</code>. If either of them is not shown in the chart, it is because it is zero - you can change the page settings to always render all the available dimensions on all charts).'
375     },
376
377     'system.pgfaults': {
378         info: 'Total page faults. <b>Major page faults</b> indicates that the system is using its swap. You can find which applications use the swap at the <a href="#menu_apps">Applications Monitoring</a> section.'
379     },
380
381     'system.entropy': {
382         colors: '#CC22AA',
383         info: '<a href="https://en.wikipedia.org/wiki/Entropy_(computing)" target="_blank">Entropy</a>, is like a pool of random numbers (<a href="https://en.wikipedia.org/wiki//dev/random" target="_blank">/dev/random</a>) that are mainly used in cryptography. It is advised that the pool remains always <a href="https://blog.cloudflare.com/ensuring-randomness-with-linuxs-random-number-generator/" target="_blank">above 200</a>. If the pool of entropy gets empty, you risk your security to be predictable and you should install a user-space random numbers generating daemon, like <code>haveged</code> or <code>rng-tools</code> (i.e. <b>rngd</b>), to keep the pool in healthy levels.'
384     },
385
386     'system.forks': {
387         colors: '#5555DD',
388         info: 'Number of new processes created.'
389     },
390
391     'system.intr': {
392         colors: '#DD5555',
393         info: 'Total number of CPU interrupts. Check <code>system.interrupts</code> that gives more detail about each interrupt and also the <a href="#menu_cpu">CPUs</a> section where interrupts are analyzed per CPU core.'
394     },
395
396     'system.interrupts': {
397         info: 'CPU interrupts in detail. At the <a href="#menu_cpu">CPUs</a> section, interrupts are analyzed per CPU core.'
398     },
399
400     'system.softirqs': {
401         info: 'CPU softirqs in detail. At the <a href="#menu_cpu">CPUs</a> section, softirqs are analyzed per CPU core.'
402     },
403
404     'system.processes': {
405         info: 'System processes. <b>Running</b> are the processes in the CPU. <b>Blocked</b> are processes that are willing to enter the CPU, but they cannot, e.g. because they wait for disk activity.'
406     },
407
408     'system.active_processes': {
409         info: 'All system processes.'
410     },
411
412     'system.ctxt': {
413         info: '<a href="https://en.wikipedia.org/wiki/Context_switch" target="_blank">Context Switches</a>, is the switching of the CPU from one process, task or thread to another. If there are many processes or threads willing to execute and very few CPU cores available to handle them, the system is making more context switching to balance the CPU resources among them. The whole process is computationally intensive. The more the context switches, the slower the system gets.'
414     },
415
416     'system.idlejitter': {
417         colors: '#5555AA',
418         info: 'Idle jitter is calculated by netdata. A thread is spawned that requests to sleep for a few microseconds. When the system wakes it up, it measures how many microseconds have passed. The difference between the requested and the actual duration of the sleep, is the <b>idle jitter</b>. This number is useful in real-time environments, where CPU jitter can affect the quality of the service (like VoIP media gateways).'
419     },
420
421     'system.ipv4': {
422         info: 'Total IPv4 Traffic.'
423     },
424
425     'system.ipv6': {
426         info: 'Total IPv6 Traffic.'
427     },
428
429     'system.ram': {
430         info: 'System Random Access Memory (i.e. physical memory) usage.'
431     },
432
433     'system.swap': {
434         info: 'System swap memory usage. Swap space is used when the amount of physical memory (RAM) is full. When the system needs more memory resources and the RAM is full, inactive pages in memory are moved to the swap space (usually a disk, a disk partition or a file).'
435     },
436
437     // ------------------------------------------------------------------------
438     // MEMORY
439
440     'mem.ksm_savings': {
441         heads: [
442             netdataDashboard.gaugeChart('Saved', '12%', 'savings', '#0099CC')
443         ]
444     },
445
446     'mem.ksm_ratios': {
447         heads: [
448             function(os, id) {
449                 void(os);
450                 return  '<div data-netdata="' + id + '"'
451                     + ' data-gauge-max-value="100"'
452                     + ' data-chart-library="gauge"'
453                     + ' data-title="Savings"'
454                     + ' data-units="percentage %"'
455                     + ' data-gauge-adjust="width"'
456                     + ' data-width="12%"'
457                     + ' data-before="0"'
458                     + ' data-after="-CHART_DURATION"'
459                     + ' data-points="CHART_DURATION"'
460                     + ' role="application"></div>';
461             }
462         ]
463     },
464
465     'mem.pgfaults': {
466         info: 'A <a href="https://en.wikipedia.org/wiki/Page_fault" target="_blank">page fault</a> is a type of interrupt, called trap, raised by computer hardware when a running program accesses a memory page that is mapped into the virtual address space, but not actually loaded into main memory. If the page is loaded in memory at the time the fault is generated, but is not marked in the memory management unit as being loaded in memory, then it is called a <b>minor</b> or soft page fault. A <b>major</b> page fault is generated when the system needs to load the memory page from disk or swap memory.'
467     },
468
469     'mem.committed': {
470         colors: NETDATA.colors[3],
471         info: 'Committed Memory, is the sum of all memory which has been allocated by processes.'
472     },
473
474     'mem.writeback': {
475         info: '<b>Dirty</b> is the amount of memory waiting to be written to disk. <b>Writeback</b> is how much memory is actively being written to disk.'
476     },
477
478     'mem.kernel': {
479         info: 'The total ammount of memory being used by the kernel. <b>Slab</b> is the amount of memory used by the kernel to cache data structures for its own use. <b>KernelStack</b> is the amount of memory allocated for each task done by the kernel. <b>PageTables</b> is the amount of memory decicated to the lowest level of page tables (A page table is used to turn a virtual address into a physical memory address). <b>VmallocUsed</b> is the amount of memory being used as virtual address space.'
480     },
481
482     'mem.slab': {
483         info: '<b>Reclaimable</b> is the amount of memory which the kernel can reuse. <b>Unreclaimable</b> can not be reused even when the kernel is lacking memory.'
484     },
485
486     // ------------------------------------------------------------------------
487     // network interfaces
488
489     'net.drops': {
490         info: 'Packets that have been dropped at the network interface level. These are the same counters reported by <code>ifconfig</code> as <code>RX dropped</code> (inbound) and <code>TX dropped</code> (outbound). <b>inbound</b> packets can be dropped at the network interface level due to <a href="#menu_system_submenu_softnet_stat">softnet backlog</a> overflow, bad / unintented VLAN tags, unknown or unregistered protocols, IPv6 frames when the server is not configured for IPv6. Check <a href="https://www.novell.com/support/kb/doc.php?id=7007165" target="_blank">this document</a> for more information.'
491     },
492
493     // ------------------------------------------------------------------------
494     // IPv4
495
496     'ipv4.tcpmemorypressures': {
497         info: 'Number of times a socket was put in <b>memory pressure</b> due to a non fatal memory allocation failure (the kernel attempts to work around this situation by reducing the send buffers, etc).'
498     },
499
500     'ipv4.tcpconnaborts': {
501         info: 'TCP connection aborts. <b>baddata</b> (<code>TCPAbortOnData</code>) happens while the connection is on <code>FIN_WAIT1</code> and the kernel receives a packet with a sequence number beyond the last one for this connection - the kernel responds with <code>RST</code> (closes the connection). <b>userclosed</b> (<code>TCPAbortOnClose</code>) happens when the kernel receives data on an already closed connection and responds with <code>RST</code>. <b>nomemory</b> (<code>TCPAbortOnMemory</code> happens when there are too many orphaned sockets (not attached to an fd) and the kernel has to drop a connection - sometimes it will send an <code>RST</code>, sometimes it won\'t. <b>timeout</b> (<code>TCPAbortOnTimeout</code>) happens when a connection times out. <b>linger</b> (<code>TCPAbortOnLinger</code>) happens when the kernel killed a socket that was already closed by the application and lingered around for long enough. <b>failed</b> (<code>TCPAbortFailed</code>) happens when the kernel attempted to send an <code>RST</code> but failed because there was no memory available.'
502     },
503
504     // ------------------------------------------------------------------------
505     // APPS
506
507     'apps.cpu': {
508         height: 2.0
509     },
510
511     'apps.mem': {
512         info: 'Real memory (RAM) used by applications. This does not include shared memory.'
513     },
514
515     'apps.vmem': {
516         info: 'Virtual memory allocated by applications. Please check <a href="https://github.com/firehol/netdata/wiki/netdata-virtual-memory-size" target="_blank">this article</a> for more information.'
517     },
518
519     'apps.preads': {
520         height: 2.0
521     },
522
523     'apps.pwrites': {
524         height: 2.0
525     },
526
527     // ------------------------------------------------------------------------
528     // USERS
529
530     'users.cpu': {
531         height: 2.0
532     },
533
534     'users.mem': {
535         info: 'Real memory (RAM) used per user. This does not include shared memory.'
536     },
537
538     'users.vmem': {
539         info: 'Virtual memory allocated per user. Please check <a href="https://github.com/firehol/netdata/wiki/netdata-virtual-memory-size" target="_blank">this article</a> for more information.'
540     },
541
542     'users.preads': {
543         height: 2.0
544     },
545
546     'users.pwrites': {
547         height: 2.0
548     },
549
550     // ------------------------------------------------------------------------
551     // GROUPS
552
553     'groups.cpu': {
554         height: 2.0
555     },
556
557     'groups.mem': {
558         info: 'Real memory (RAM) used per user group. This does not include shared memory.'
559     },
560
561     'groups.vmem': {
562         info: 'Virtual memory allocated per user group. Please check <a href="https://github.com/firehol/netdata/wiki/netdata-virtual-memory-size" target="_blank">this article</a> for more information.'
563     },
564
565     'groups.preads': {
566         height: 2.0
567     },
568
569     'groups.pwrites': {
570         height: 2.0
571     },
572
573     // ------------------------------------------------------------------------
574     // NETWORK QoS
575
576     'tc.qos': {
577         heads: [
578             function(os, id) {
579                 void(os);
580
581                 if(id.match(/.*-ifb$/))
582                     return netdataDashboard.gaugeChart('Inbound', '12%', '', '#5555AA');
583                 else
584                     return netdataDashboard.gaugeChart('Outbound', '12%', '', '#AA9900');
585             }
586         ]
587     },
588
589     // ------------------------------------------------------------------------
590     // NETWORK INTERFACES
591
592     'net.net': {
593         heads: [
594             netdataDashboard.gaugeChart('Received', '12%', 'received'),
595             netdataDashboard.gaugeChart('Sent', '12%', 'sent')
596         ]
597     },
598
599     // ------------------------------------------------------------------------
600     // NETFILTER
601
602     'netfilter.sockets': {
603         colors: '#88AA00',
604         heads: [
605             netdataDashboard.gaugeChart('Active Connections', '12%', '', '#88AA00')
606         ]
607     },
608
609     'netfilter.new': {
610         heads: [
611             netdataDashboard.gaugeChart('New Connections', '12%', 'new', '#5555AA')
612         ]
613     },
614
615     // ------------------------------------------------------------------------
616     // DISKS
617
618     'disk.util': {
619         colors: '#FF5588',
620         heads: [
621             netdataDashboard.gaugeChart('Utilization', '12%', '', '#FF5588')
622         ],
623         info: 'Disk Utilization measures the amount of time the disk was busy with something. This is not related to its performance. 100% means that the system always had an outstanding operation on the disk. Keep in mind that depending on the underlying technology of the disk, 100% here may or may not be an indication of congestion.'
624     },
625
626     'disk.backlog': {
627         colors: '#0099CC',
628         info: 'Backlog is an indication of the duration of pending disk operations. On every I/O event the system is multiplying the time spent doing I/O since the last update of this field with the number of pending operations. While not accurate, this metric can provide an indication of the expected completion time of the operations in progress.'
629     },
630
631     'disk.io': {
632         heads: [
633             netdataDashboard.gaugeChart('Read', '12%', 'reads'),
634             netdataDashboard.gaugeChart('Write', '12%', 'writes')
635         ],
636         info: 'Amount of data transferred to and from disk.'
637     },
638
639     'disk.ops': {
640         info: 'Completed disk I/O operations. Keep in mind the number of operations requested might be higher, since the system is able to merge adjacent to each other (see merged operations chart).'
641     },
642
643     'disk.qops': {
644         info: 'I/O operations currently in progress. This metric is a snapshot - it is not an average over the last interval.'
645     },
646
647     'disk.iotime': {
648         height: 0.5,
649         info: 'The sum of the duration of all completed I/O operations. This number can exceed the interval if the disk is able to execute I/O operations in parallel.'
650     },
651     'disk.mops': {
652         height: 0.5,
653         info: 'The number of merged disk operations. The system is able to merge adjacent I/O operations, for example two 4KB reads can become one 8KB read before given to disk.'
654     },
655     'disk.svctm': {
656         height: 0.5,
657         info: 'The average service time for completed I/O operations. This metric is calculated using the total busy time of the disk and the number of completed operations. If the disk is able to execute multiple parallel operations the reporting average service time will be misleading.'
658     },
659     'disk.avgsz': {
660         height: 0.5,
661         info: 'The average I/O operation size.'
662     },
663     'disk.await': {
664         height: 0.5,
665         info: 'The average time for I/O requests issued to the device to be served. This includes the time spent by the requests in queue and the time spent servicing them.'
666     },
667
668     'disk.space': {
669         info: 'Disk space utilization. reserved for root is automatically reserved by the system to prevent the root user from getting out of space.'
670     },
671     'disk.inodes': {
672         info: 'inodes (or index nodes) are filesystem objects (e.g. files and directories). On many types of file system implementations, the maximum number of inodes is fixed at filesystem creation, limiting the maximum number of files the filesystem can hold. It is possible for a device to run out of inodes. When this happens, new files cannot be created on the device, even though there may be free space available.'
673     },
674
675     'mysql.net': {
676         info: 'The amount of data sent to mysql clients (<strong>out</strong>) and received from mysql clients (<strong>in</strong>).'
677     },
678
679     // ------------------------------------------------------------------------
680     // MYSQL
681
682     'mysql.queries': {
683         info: 'The number of statements executed by the server.<ul>' +
684         '<li><strong>queries</strong> counts the statements executed within stored SQL programs.</li>' +
685         '<li><strong>questions</strong> counts the statements sent to the mysql server by mysql clients.</li>' +
686         '<li><strong>slow queries</strong> counts the number of statements that took more than <a href="http://dev.mysql.com/doc/refman/5.7/en/server-system-variables.html#sysvar_long_query_time" target="_blank">long_query_time</a> seconds to be executed.' +
687         ' For more information about slow queries check the mysql <a href="http://dev.mysql.com/doc/refman/5.7/en/slow-query-log.html" target="_blank">slow query log</a>.</li>' +
688         '</ul>'
689     },
690
691     'mysql.handlers': {
692         info: 'Usage of the internal handlers of mysql. This chart provides very good insights of what the mysql server is actually doing.' +
693         ' (if the chart is not showing all these dimensions it is because they are zero - set <strong>Which dimensions to show?</strong> to <strong>All</strong> from the dashboard settings, to render even the zero values)<ul>' +
694         '<li><strong>commit</strong>, the number of internal <a href="http://dev.mysql.com/doc/refman/5.7/en/commit.html" target="_blank">COMMIT</a> statements.</li>' +
695         '<li><strong>delete</strong>, the number of times that rows have been deleted from tables.</li>' +
696         '<li><strong>prepare</strong>, a counter for the prepare phase of two-phase commit operations.</li>' +
697         '<li><strong>read first</strong>, the number of times the first entry in an index was read. A high value suggests that the server is doing a lot of full index scans; e.g. <strong>SELECT col1 FROM foo</strong>, with col1 indexed.</li>' +
698         '<li><strong>read key</strong>, the number of requests to read a row based on a key. If this value is high, it is a good indication that your tables are properly indexed for your queries.</li>' +
699         '<li><strong>read next</strong>, the number of requests to read the next row in key order. This value is incremented if you are querying an index column with a range constraint or if you are doing an index scan.</li>' +
700         '<li><strong>read prev</strong>, the number of requests to read the previous row in key order. This read method is mainly used to optimize <strong>ORDER BY ... DESC</strong>.</li>' +
701         '<li><strong>read rnd</strong>, the number of requests to read a row based on a fixed position. A high value indicates you are doing a lot of queries that require sorting of the result. You probably have a lot of queries that require MySQL to scan entire tables or you have joins that do not use keys properly.</li>' +
702         '<li><strong>read rnd next</strong>, the number of requests to read the next row in the data file. This value is high if you are doing a lot of table scans. Generally this suggests that your tables are not properly indexed or that your queries are not written to take advantage of the indexes you have.</li>' +
703         '<li><strong>rollback</strong>, the number of requests for a storage engine to perform a rollback operation.</li>' +
704         '<li><strong>savepoint</strong>, the number of requests for a storage engine to place a savepoint.</li>' +
705         '<li><strong>savepoint rollback</strong>, the number of requests for a storage engine to roll back to a savepoint.</li>' +
706         '<li><strong>update</strong>, the number of requests to update a row in a table.</li>' +
707         '<li><strong>write</strong>, the number of requests to insert a row in a table.</li>' +
708         '</ul>'
709     },
710
711     'mysql.table_locks': {
712         info: 'MySQL table locks counters: <ul>' +
713         '<li><strong>immediate</strong>, the number of times that a request for a table lock could be granted immediately.</li>' +
714         '<li><strong>waited</strong>, the number of times that a request for a table lock could not be granted immediately and a wait was needed. If this is high and you have performance problems, you should first optimize your queries, and then either split your table or tables or use replication.</li>' +
715         '</ul>'
716     },
717
718     // ------------------------------------------------------------------------
719     // APACHE
720
721     'apache.connections': {
722         colors: NETDATA.colors[4],
723         mainheads: [
724             netdataDashboard.gaugeChart('Connections', '12%', '', NETDATA.colors[4])
725         ]
726     },
727
728     'apache.requests': {
729         colors: NETDATA.colors[0],
730         mainheads: [
731             netdataDashboard.gaugeChart('Requests', '12%', '', NETDATA.colors[0])
732         ]
733     },
734
735     'apache.net': {
736         colors: NETDATA.colors[3],
737         mainheads: [
738             netdataDashboard.gaugeChart('Bandwidth', '12%', '', NETDATA.colors[3])
739         ]
740     },
741
742     'apache.workers': {
743         mainheads: [
744             function(os, id) {
745                 void(os);
746                 return  '<div data-netdata="' + id + '"'
747                     + ' data-dimensions="busy"'
748                     + ' data-append-options="percentage"'
749                     + ' data-gauge-max-value="100"'
750                     + ' data-chart-library="gauge"'
751                     + ' data-title="Workers Utilization"'
752                     + ' data-units="percentage %"'
753                     + ' data-gauge-adjust="width"'
754                     + ' data-width="12%"'
755                     + ' data-before="0"'
756                     + ' data-after="-CHART_DURATION"'
757                     + ' data-points="CHART_DURATION"'
758                     + ' role="application"></div>';
759             }
760         ]
761     },
762
763     'apache.bytesperreq': {
764         colors: NETDATA.colors[3],
765         height: 0.5
766     },
767
768     'apache.reqpersec': {
769         colors: NETDATA.colors[4],
770         height: 0.5
771     },
772
773     'apache.bytespersec': {
774         colors: NETDATA.colors[6],
775         height: 0.5
776     },
777
778
779     // ------------------------------------------------------------------------
780     // NGINX
781
782     'nginx.connections': {
783         colors: NETDATA.colors[4],
784         mainheads: [
785             netdataDashboard.gaugeChart('Connections', '12%', '', NETDATA.colors[4])
786         ]
787     },
788
789     'nginx.requests': {
790         colors: NETDATA.colors[0],
791         mainheads: [
792             netdataDashboard.gaugeChart('Requests', '12%', '', NETDATA.colors[0])
793         ]
794     },
795
796     // ------------------------------------------------------------------------
797     // NETDATA
798
799     'netdata.response_time': {
800         info: 'The netdata API response time measures the time netdata needed to serve requests. This time includes everything, from the reception of the first byte of a request, to the dispatch of the last byte of its reply, therefore it includes all network latencies involved (i.e. a client over a slow network will influence these metrics).'
801     },
802
803     // ------------------------------------------------------------------------
804     // RETROSHARE
805
806     'retroshare.bandwidth': {
807         info: 'RetroShare inbound and outbound traffic.',
808         mainheads: [
809             netdataDashboard.gaugeChart('Received', '12%', 'bandwidth_down_kb'),
810             netdataDashboard.gaugeChart('Sent', '12%', 'bandwidth_up_kb')
811         ]
812     },
813
814     'retroshare.peers': {
815         info: 'Number of (connected) RetroShare friends.',
816         mainheads: [
817             function(os, id) {
818                 void(os);
819                 return  '<div data-netdata="' + id + '"'
820                     + ' data-dimensions="peers_connected"'
821                     + ' data-append-options="friends"'
822                     + ' data-chart-library="easypiechart"'
823                     + ' data-title="connected friends"'
824                     + ' data-units=""'
825                     + ' data-width="8%"'
826                     + ' data-before="0"'
827                     + ' data-after="-CHART_DURATION"'
828                     + ' data-points="CHART_DURATION"'
829                     + ' role="application"></div>';
830             }
831         ]
832     },
833
834     'retroshare.dht': {
835         info: 'Statistics about RetroShare\'s DHT. These values are estimated!'
836     },
837
838     // ------------------------------------------------------------------------
839     // fping
840
841     'fping.quality': {
842         colors: NETDATA.colors[10],
843         height: 0.5
844     },
845
846     'fping.packets': {
847         height: 0.5
848     },
849
850     'web_log.response_codes': {
851         info: 'Break down of web server responses by response code type. <code>1xx</code> are informational responses, <code>2xx</code> are successful responses, <code>3xx</code> are redirects, <code>4xx</code> are bad requests, <code>5xx</code> are internal server errors, <code>other</code> are non-standard responses, <code>unmatched</code> counts the lines in the log file that are not matched by the plugin (please <a href="https://github.com/firehol/netdata/issues/new?title=web_log%20reports%20unmatched%20lines&body=web_log%20plugin%20reports%20unmatched%20lines.%0A%0AThis%20is%20my%20log:%0A%0A%60%60%60txt%0A%0Aplease%20paste%20your%20web%20server%20log%20here%0A%0A%60%60%60" target="_blank">open a github issue</a> to help us fix it, if you have any unmatched lines).',
852
853         mainheads: [
854             function(os, id) {
855                 void(os);
856                 return  '<div data-netdata="' + id + '"'
857                     + ' data-dimensions="2xx"'
858                     + ' data-chart-library="gauge"'
859                     + ' data-title="Successful"'
860                     + ' data-units="requests/s"'
861                     + ' data-gauge-adjust="width"'
862                     + ' data-width="12%"'
863                     + ' data-before="0"'
864                     + ' data-after="-CHART_DURATION"'
865                     + ' data-points="CHART_DURATION"'
866                     + ' data-common-max="' + id + '"'
867                     + ' data-colors="' + NETDATA.colors[0] + '"'
868                     + ' data-decimal-digits="0"'
869                     + ' role="application"></div>';
870             },
871
872             function(os, id) {
873                 void(os);
874                 return  '<div data-netdata="' + id + '"'
875                     + ' data-dimensions="3xx"'
876                     + ' data-chart-library="gauge"'
877                     + ' data-title="Redirects"'
878                     + ' data-units="requests/s"'
879                     + ' data-gauge-adjust="width"'
880                     + ' data-width="12%"'
881                     + ' data-before="0"'
882                     + ' data-after="-CHART_DURATION"'
883                     + ' data-points="CHART_DURATION"'
884                     + ' data-common-max="' + id + '"'
885                     + ' data-colors="' + NETDATA.colors[2] + '"'
886                     + ' data-decimal-digits="0"'
887                     + ' role="application"></div>';
888             },
889
890             function(os, id) {
891                 void(os);
892                 return  '<div data-netdata="' + id + '"'
893                     + ' data-dimensions="4xx"'
894                     + ' data-chart-library="gauge"'
895                     + ' data-title="Bad Requests"'
896                     + ' data-units="requests/s"'
897                     + ' data-gauge-adjust="width"'
898                     + ' data-width="12%"'
899                     + ' data-before="0"'
900                     + ' data-after="-CHART_DURATION"'
901                     + ' data-points="CHART_DURATION"'
902                     + ' data-common-max="' + id + '"'
903                     + ' data-colors="' + NETDATA.colors[3] + '"'
904                     + ' data-decimal-digits="0"'
905                     + ' role="application"></div>';
906             },
907
908             function(os, id) {
909                 void(os);
910                 return  '<div data-netdata="' + id + '"'
911                     + ' data-dimensions="5xx"'
912                     + ' data-chart-library="gauge"'
913                     + ' data-title="Server Errors"'
914                     + ' data-units="requests/s"'
915                     + ' data-gauge-adjust="width"'
916                     + ' data-width="12%"'
917                     + ' data-before="0"'
918                     + ' data-after="-CHART_DURATION"'
919                     + ' data-points="CHART_DURATION"'
920                     + ' data-common-max="' + id + '"'
921                     + ' data-colors="' + NETDATA.colors[1] + '"'
922                     + ' data-decimal-digits="0"'
923                     + ' role="application"></div>';
924             }
925         ]
926     },
927
928     'web_log.response_time': {
929         mainheads: [
930             function(os, id) {
931                 void(os);
932                 return  '<div data-netdata="' + id + '"'
933                     + ' data-dimensions="avg"'
934                     + ' data-chart-library="gauge"'
935                     + ' data-title="Average Response Time"'
936                     + ' data-units="milliseconds"'
937                     + ' data-gauge-adjust="width"'
938                     + ' data-width="12%"'
939                     + ' data-before="0"'
940                     + ' data-after="-CHART_DURATION"'
941                     + ' data-points="CHART_DURATION"'
942                     + ' data-colors="' + NETDATA.colors[4] + '"'
943                     + ' data-decimal-digits="2"'
944                     + ' role="application"></div>';
945             }
946         ]
947     },
948
949     'web_log.detailed_response_codes': {
950         info: 'Number of responses for each response code.'
951     },
952
953     'web_log.requests_per_ipproto': {
954         info: 'Web server requests received per IP protocol version.'
955     },
956
957     'web_log.clients': {
958         info: 'Unique client IPs accessing the web server, within each data collection iteration. If data collection is <b>per second</b>, this chart shows <b>unique client IPs per second</b>.'
959     },
960
961     'web_log.clients_all': {
962         info: 'Unique client IPs accessing the web server since the last restart of netdata. This plugin keeps in memory all the unique IPs that have accessed the web server. On very busy web servers (several millions of unique IPs) you may want to disable this chart (check <a href="https://github.com/firehol/netdata/blob/master/conf.d/python.d/web_log.conf" target="_blank"><code>/etc/netdata/python.d/web_log.conf</code></a>).'
963     }
964
965 };