Merge lp:~richardw/jarmon/independent-ds-transformers-1188220 into lp:jarmon

[Richard Wall]

I hacked things around a bit.

RrdDsProxy now accepts transformer and passes as an argument to RrdQuery/RrdQueryRemote.getData

I'm not really happy with this but it does have the desired effect (at least for me with Fedora/Chrome/collectd5)

When I eventually get round to releasing another Jarmon, I might update / simplify all this RRD download and parsing code.

Anyway, please try out jarmon.js from this branch and let me know if it fixes things for you.

[Petr P (trubus)]

I just tested it on our setup - it has the desired effect, I'm almost completely satisfied, but other thing turned up.

When the resulting graph is mostly negative (let's imagine Y-axis has max = 100 and min = -1000000, in other words, there is a lot more TX than RX for example), it sets the prefix incorrectly (according to the max value only) and it generates lot of steps.

I propose using the greater value of axis.min and axis.max in "this.options.yaxis.ticks" instead of axis.max only. Other possibility is to use difference (axis.max - axis.min), but that seems a bit more tricky to me.

Other than that it works fine, thanks a lot!

Peter

[Petr P (trubus)]

Just to be a bit more precise - I don't propose using greater value, but the value that is farther away from zero :)

[Petr P (trubus)]

It seems a quick fix, could you add this small change? Then I'll approve :)

652c652
< if( Math.pow(1000, si+1)*0.9 > axis.max ) {
---
> if( Math.pow(1000, si+1)*0.9 > axis.max && -(Math.pow(1000, si+1))*0.9 < axis.min) {

[lp:~richardw/jarmon/independent-ds-transformers-1188220]

78. By Richard Wall on 2013-06-20

add extra condition suggested by trubus to take into account negative y axis

79. By Richard Wall on 2013-06-20

choose best si based on total length of y axis - negative to positive. Also add a few more step sizes to graphs without any ticks.

[Richard Wall (richardw)]

I applied your diff and it does give properly spaced negative ticks, but I couldn't clearly understand why.
I came up with a slightly different condition which seems to have the same effect and which I think I understand.

See what you think and let me know if it works for you.

I also added a couple of extra step sizes because (on my system ) I was graphs with only two tick labels.

Thanks again for testing.

-RichardW.

review: Needs Resubmitting (functional testing)

[Petr P (trubus)]

Works as expected, great job!

review: Approve (functional testing)

Unmerged revisions

79. By Richard Wall on 2013-06-20

choose best si based on total length of y axis - negative to positive. Also add a few more step sizes to graphs without any ticks.

78. By Richard Wall on 2013-06-20

add extra condition suggested by trubus to take into account negative y axis

77. By Richard Wall on 2013-06-14

hack things around to allow independent ds transformers, even when they are in the same RRD file

=== modified file 'docs/examples/jarmon_example_recipes.js'
--- docs/examples/jarmon_example_recipes.js	2011-09-10 10:52:52 +0000
+++ docs/examples/jarmon_example_recipes.js	2013-06-20 23:01:24 +0000
@@ -54,8 +54,8 @@
     'interface': {
         title: 'Wlan0 Throughput',
         data: [
-            ['data/interface/if_octets-wlan0.rrd', 'tx', 'Transmit', 'bit/s', function (v) { return v*8; }],
-            ['data/interface/if_octets-wlan0.rrd', 'rx', 'Receive', 'bit/s', function (v) { return v*8; }]
+            ['data/interface-wlan0/if_octets.rrd', 'tx', 'Transmit', 'bit/s', function (v) { return -v*8; }],
+            ['data/interface-wlan0/if_octets.rrd', 'rx', 'Receive', 'bit/s', function (v) { return v*8; }]
         ],
         options: jQuery.extend(true, {}, jarmon.Chart.BASE_OPTIONS)
     },

=== modified file 'jarmon/jarmon.js'
--- jarmon/jarmon.js	2011-09-11 09:29:53 +0000
+++ jarmon/jarmon.js	2013-06-20 23:01:24 +0000
@@ -337,21 +337,14 @@
  * @constructor
  * @param rrd {Object} A javascriptrrd.RRDFile
  * @param unit {String} The unit symbol for this data series
- * @param transformer {Function} A callable which performs a
- *      tranfsformation of the values returned from the RRD file.
  **/
-jarmon.RrdQuery = function(rrd, unit, transformer) {
+jarmon.RrdQuery = function(rrd, unit) {
     this.rrd = rrd;
     this.unit = unit;
-    if(typeof(transformer) !== 'undefined') {
- 	    this.transformer = transformer;
- 	} else {
- 	    this.transformer = function(v) {return v;};
- 	}
 };
 
 jarmon.RrdQuery.prototype.getData = function(startTimeJs, endTimeJs,
-                                             dsId, cfName) {
+                                             dsId, cfName, transformer) {
     /**
      * Generate a Flot compatible data object containing rows between start and
      * end time. The rows are taken from the first RRA whose data spans the
@@ -363,6 +356,8 @@
      * @param dsId {Variant} identifier of the RRD datasource (string or number)
      * @param cfName {String} The name of an RRD consolidation function (CF)
      *      eg AVERAGE, MIN, MAX
+     * @param transformer {Function} A callable which performs a
+     *      tranfsformation of the values returned from the RRD file.
      * @return {Object} A Flot compatible data series
      *      eg label: '', data: [], unit: ''
      **/
@@ -392,6 +387,10 @@
         cfName = 'AVERAGE';
     }
 
+    if(typeof(transformer) === 'undefined') {
+        transformer = function(v) {return v;};
+    }
+
     var rra, step, rraRowCount, lastRowTime, firstRowTime;
 
     for(var i=0; i<this.rrd.getNrRRAs(); i++) {
@@ -450,7 +449,7 @@
     var val;
     var timestamp = startRowTime;
     for(i=startRowIndex; i<endRowIndex; i++) {
-        val = this.transformer(rra.getEl(i, dsIndex));
+        val = transformer(rra.getEl(i, dsIndex));
         flotData.push([timestamp*1000.0, val]);
         timestamp += step;
     }
@@ -487,10 +486,8 @@
  * @param unit {String} The unit suffix of this data eg 'bit/sec'
  * @param downloader {Function} A callable which returns a Deferred and calls
  *      back with a javascriptrrd.BinaryFile when it has downloaded.
- * @param transformer {Function} A callable which performs a
- *      tranfsformation of the values returned from the RRD file.
  **/
-jarmon.RrdQueryRemote = function(url, unit, downloader, transformer) {
+jarmon.RrdQueryRemote = function(url, unit, downloader) {
     this.url = url;
     this.unit = unit;
     if(typeof(downloader) == 'undefined') {
@@ -498,7 +495,6 @@
     } else {
         this.downloader = downloader;
     }
-    this.transformer = transformer;
 
     this.lastUpdate = 0;
     this._download = null;
@@ -529,7 +525,7 @@
                 var rrd = new RRDFile(res);
                 self.lastUpdate = rrd.getLastUpdate();
 
-                var rq = new jarmon.RrdQuery(rrd, self.unit, self.transformer);
+                var rq = new jarmon.RrdQuery(rrd, self.unit);
                 try {
                     ret.resolve(rq[methodName].apply(rq, args));
                 } catch(e) {
@@ -544,7 +540,7 @@
 
 
 jarmon.RrdQueryRemote.prototype.getData = function(startTime, endTime,
-                                                   dsId, cfName) {
+                                                   dsId, cfName, transformer) {
     /**
      * Return a Flot compatible data series asynchronously.
      *
@@ -552,12 +548,16 @@
      * @param startTime {Number} The start timestamp
      * @param endTime {Number} The end timestamp
      * @param dsId {Variant} identifier of the RRD datasource (string or number)
+     * @param cfName {String} The name of an RRD consolidation function (CF)
+     *      eg AVERAGE, MIN, MAX
+     * @param transformer {Function} A callable which performs a
+     *      tranfsformation of the values returned from the RRD file.
      * @return {Object} A Deferred which calls back with a flot data series.
      **/
     if(this.lastUpdate < endTime/1000) {
         this._download = null;
     }
-    return this._callRemote('getData', [startTime, endTime, dsId, cfName]);
+    return this._callRemote('getData', [startTime, endTime, dsId, cfName, transformer]);
 };
 
 
@@ -581,10 +581,11 @@
  * @param rrdQuery {Object} An RrdQueryRemote instance
  * @param dsId {Variant} identifier of the RRD datasource (string or number)
  **/
-jarmon.RrdQueryDsProxy = function(rrdQuery, dsId) {
+jarmon.RrdQueryDsProxy = function(rrdQuery, dsId, transformer) {
     this.rrdQuery = rrdQuery;
     this.dsId = dsId;
     this.unit = rrdQuery.unit;
+    this.transformer = transformer;
 };
 
 jarmon.RrdQueryDsProxy.prototype.getData = function(startTime, endTime) {
@@ -596,7 +597,7 @@
      * @param endTime {Number} A unix timestamp marking the start time
      * @return {Object} A Deferred which calls back with a flot data series.
      **/
-    return this.rrdQuery.getData(startTime, endTime, this.dsId);
+    return this.rrdQuery.getData(startTime, endTime, this.dsId, undefined, this.transformer);
 };
 
 
@@ -648,7 +649,7 @@
         };
         var si = 0;
         while(true) {
-            if( Math.pow(1000, si+1)*0.9 > axis.max ) {
+            if( Math.pow(1000, si+1)*0.9 > (axis.max - axis.min) ) {
                 break;
             }
             si++;
@@ -658,7 +659,7 @@
         var maxVal = axis.max/Math.pow(1000, si);
 
         var stepSizes = [0.01, 0.05, 0.1, 0.25, 0.5,
-                         1, 5, 10, 25, 50, 100, 250];
+                         1, 2, 5, 10, 20, 25, 50, 100, 250];
         var realStep = (maxVal - minVal)/5.0;
 
         var stepSize, decimalPlaces = 0;
@@ -712,9 +713,9 @@
 
         if(typeof(dataDict[rrd]) === 'undefined') {
             dataDict[rrd] = new jarmon.RrdQueryRemote(
-                rrd, unit, this.downloader, transformer);
+                rrd, unit, this.downloader);
         }
-        this.addData(label, new jarmon.RrdQueryDsProxy(dataDict[rrd], ds));
+        this.addData(label, new jarmon.RrdQueryDsProxy(dataDict[rrd], ds, transformer));
     }
 };