grafana/panels/trends/module.js

/*jshint globalstrict:true */
/*global angular:true */
/*

  ## Trends

  Shows how queries are moving from a specified time ago

  ### Parameters
  * style :: A hash of css styles
  * arrangement :: How should I arrange the query results? 'horizontal' or 'vertical'
  * ago :: Date math formatted time to look back
  ### Group Events
  #### Sends
  * get_time :: On panel initialization get time range to query
  #### Receives
  * time :: An object containing the time range to use and the index(es) to query
  * query :: An Array of queries, even if its only one

*/

'use strict';

angular.module('kibana.trends', [])
.controller('trends', function($scope, kbnIndex, querySrv, dashboard, filterSrv) {

  // Set and populate defaults
  var _d = {
    status  : "Beta",
    query   : ["*"],
    group   : "default",
    style   : { "font-size": '14pt'},
    ago     : '1d',
    arrangement : 'vertical',
  };
  _.defaults($scope.panel,_d);

  $scope.init = function () {
    $scope.hits = 0;

    $scope.$on('refresh',function(){$scope.get_data();});

    $scope.get_data();
  };

  $scope.get_data = function(segment,query_id) {
    delete $scope.panel.error;
    $scope.panel.loading = true;

    // Make sure we have everything for the request to complete
    if(dashboard.indices.length === 0) {
      return;
    } else {
      $scope.index = segment > 0 ? $scope.index : dashboard.indices;
    }

    // Determine a time field
    var timeField = _.uniq(_.pluck(filterSrv.getByType('time'),'field'));
    if(timeField.length > 1) {
      $scope.panel.error = "Time field must be consistent amongst time filters";
      return;
    } else if(timeField.length === 0) {
      $scope.panel.error = "A time filter must exist for this panel to function";
      return;
    } else {
      timeField = timeField[0];
    }

    $scope.time = filterSrv.timeRange('min');
    $scope.old_time = {
      from : new Date($scope.time.from.getTime() - kbn.interval_to_seconds($scope.panel.ago)*1000),
      to   : new Date($scope.time.to.getTime() - kbn.interval_to_seconds($scope.panel.ago)*1000)
    };

    var _segment = _.isUndefined(segment) ? 0 : segment;
    var request = $scope.ejs.Request();
    var _ids_without_time = _.difference(filterSrv.ids,filterSrv.idsByType('time'));


    // Build the question part of the query
    _.each(querySrv.ids, function(id) {
      var q = $scope.ejs.FilteredQuery(
        querySrv.getEjsObj(id),
        filterSrv.getBoolFilter(_ids_without_time).must(
          $scope.ejs.RangeFilter(timeField)
          .from($scope.time.from)
          .to($scope.time.to)
        ));

      request = request
        .facet($scope.ejs.QueryFacet(id)
          .query(q)
        ).size(0);
    });


    // And again for the old time period
    _.each(querySrv.ids, function(id) {
      var q = $scope.ejs.FilteredQuery(
        querySrv.getEjsObj(id),
        filterSrv.getBoolFilter(_ids_without_time).must(
          $scope.ejs.RangeFilter(timeField)
          .from($scope.old_time.from)
          .to($scope.old_time.to)
        ));
      request = request
        .facet($scope.ejs.QueryFacet("old_"+id)
          .query(q)
        ).size(0);
    });


    // TODO: Spy for trend panel
    //$scope.populate_modal(request);

    // If we're on the first segment we need to get our indices
    if (_segment === 0) {
      kbnIndex.indices(
        $scope.old_time.from,
        $scope.old_time.to,
        dashboard.current.index.pattern,
        dashboard.current.index.interval
      ).then(function (p) {
        $scope.index = _.union(p,$scope.index);
        request = request.indices($scope.index[_segment]);
        process_results(request.doSearch(),_segment,query_id);
      });
    } else {
      process_results(request.indices($scope.index[_segment]).doSearch(),_segment,query_id);
    }

  };

  // Populate scope when we have results
  var process_results = function(results,_segment,query_id) { 
    results.then(function(results) {
      $scope.panel.loading = false;
      if(_segment === 0) {
        $scope.hits = {};
        $scope.data = [];
        query_id = $scope.query_id = new Date().getTime();
      }
      
      // Check for error and abort if found
      if(!(_.isUndefined(results.error))) {
        $scope.panel.error = $scope.parse_error(results.error);
        return;
      }

      // Convert facet ids to numbers
      var facetIds = _.map(_.keys(results.facets),function(k){if(!isNaN(k)){return parseInt(k, 10);}});

      // Make sure we're still on the same query/queries
      if($scope.query_id === query_id && 
        _.intersection(facetIds,querySrv.ids).length === querySrv.ids.length
        ) {
        var i = 0;
        _.each(querySrv.ids, function(id) {
          var v = results.facets[id];
          var n = results.facets[id].count;
          var o = results.facets['old_'+id].count;

          var hits = {
            new : _.isUndefined($scope.data[i]) || _segment === 0 ? n : $scope.data[i].hits.new+n,        
            old : _.isUndefined($scope.data[i]) || _segment === 0 ? o : $scope.data[i].hits.old+o
          };
          
          $scope.hits.new += n;
          $scope.hits.old += o;

          var percent = percentage(hits.old,hits.new) == null ? 
            '?' : Math.round(percentage(hits.old,hits.new)*100)/100;
          // Create series
          $scope.data[i] = { 
            info: querySrv.list[id],
            hits: {
              new : hits.new,
              old : hits.old
            },
            percent: percent
          };

          i++;
        });
        $scope.$emit('render');
        if(_segment < $scope.index.length-1) {
          $scope.get_data(_segment+1,query_id);
        } else {
          $scope.trends = $scope.data;
        }
      }
    });
  };

  function percentage(x,y) {
    return x === 0 ? null : 100*(y-x)/x;
  }

  $scope.set_refresh = function (state) { 
    $scope.refresh = state; 
  };

  $scope.close_edit = function() {
    if($scope.refresh) {
      $scope.get_data();
    }
    $scope.refresh =  false;
    $scope.$emit('render');
  };

});