1 # no need for shebang - this file is loaded from charts.d.plugin
4 # real-time performance and health monitoring, done right!
5 # (C) 2016 Costa Tsaousis <costa@tsaousis.gr>
9 # if this chart is called X.chart.sh, then all functions and global variables
12 # _update_every is a special variable - it holds the number of seconds
13 # between the calls of the _update() function
16 # the priority is used to sort the charts on the dashboard
18 example_priority=150000
20 # to enable this chart, you have to set this to 12345
21 # (just a demonstration for something that needs to be checked)
24 # global variables to store our collected data
25 # remember: they need to start with the module name example_
34 # do all the work to collect / calculate the values
38 # 1. KEEP IT SIMPLE AND SHORT
39 # 2. AVOID FORKS (avoid piping commands)
40 # 3. AVOID CALLING TOO MANY EXTERNAL PROGRAMS
41 # 4. USE LOCAL VARIABLES (global variables may overlap with other modules)
43 example_value1=$RANDOM
44 example_value2=$RANDOM
45 example_value3=$RANDOM
46 example_value4=$((8192 + (RANDOM * 16383 / 32767) ))
48 if [ $example_count -gt 0 ]
50 example_count=$((example_count - 1))
52 [ $example_last -gt 16383 ] && example_value4=$((example_last + (RANDOM * ( (32767 - example_last) / 2) / 32767)))
53 [ $example_last -le 16383 ] && example_value4=$((example_last - (RANDOM * (example_last / 2) / 32767)))
55 example_count=$((1 + (RANDOM * 5 / 32767) ))
57 [ $example_last -gt 16383 -a $example_value4 -gt 16383 ] && example_value4=$((example_value4 - 16383))
58 [ $example_last -le 16383 -a $example_value4 -lt 16383 ] && example_value4=$((example_value4 + 16383))
60 example_last=$example_value4
63 # - 0 to send the data to netdata
64 # - 1 to report a failure to collect the data
69 # _check is called once, to find out if this chart should be enabled or not
72 # - 0 to enable the chart
73 # - 1 to disable the chart
76 [ "${example_magic_number}" != "12345" ] && error "manual configuration required: you have to set example_magic_number=$example_magic_number in example.conf to start example chart." && return 1
78 # check that we can collect data
79 example_get || return 1
84 # _create is called once, to create the charts
86 # create the chart with 3 dimensions
88 CHART example.random '' "Random Numbers Stacked Chart" "% of random numbers" random random stacked $((example_priority)) $example_update_every
89 DIMENSION random1 '' percentage-of-absolute-row 1 1
90 DIMENSION random2 '' percentage-of-absolute-row 1 1
91 DIMENSION random3 '' percentage-of-absolute-row 1 1
92 CHART example.random2 '' "A random number" "random number" random random area $((example_priority + 1)) $example_update_every
93 DIMENSION random '' absolute 1 1
99 # _update is called continiously, to collect the values
101 # the first argument to this function is the microseconds since last update
102 # pass this parameter to the BEGIN statement (see bellow).
104 example_get || return 1
106 # write the result of the work.
108 BEGIN example.random $1
109 SET random1 = $example_value1
110 SET random2 = $example_value2
111 SET random3 = $example_value3
113 BEGIN example.random2 $1
114 SET random = $example_value4