grafana/public/app/plugins/datasource/graphite/datasource.ts

///<reference path="../../../headers/common.d.ts" />

import angular from 'angular';
import _ from 'lodash';
import moment from 'moment';

import * as dateMath from 'app/core/utils/datemath';

/** @ngInject */
export function GraphiteDatasource(instanceSettings, $q, backendSrv, templateSrv) {
  this.basicAuth = instanceSettings.basicAuth;
  this.url = instanceSettings.url;
  this.name = instanceSettings.name;
  this.cacheTimeout = instanceSettings.cacheTimeout;
  this.withCredentials = instanceSettings.withCredentials;
  this.render_method = instanceSettings.render_method || 'POST';

  this.query = function(options) {
    try {
      var graphOptions = {
        from: this.translateTime(options.rangeRaw.from, false),
        until: this.translateTime(options.rangeRaw.to, true),
        targets: options.targets,
        format: options.format,
        cacheTimeout: options.cacheTimeout || this.cacheTimeout,
        maxDataPoints: options.maxDataPoints,
      };

      var params = this.buildGraphiteParams(graphOptions, options.scopedVars);
      if (params.length === 0) {
        return $q.when([]);
      }

      if (options.format === 'png') {
        return $q.when(this.url + '/render' + '?' + params.join('&'));
      }

      var httpOptions: any = {method: this.render_method, url: '/render'};

      if (httpOptions.method === 'GET') {
        httpOptions.url = httpOptions.url + '?' + params.join('&');
      } else {
        httpOptions.data = params.join('&');
        httpOptions.headers = { 'Content-Type': 'application/x-www-form-urlencoded' };
      }

      return this.doGraphiteRequest(httpOptions).then(this.convertDataPointsToMs);
    } catch (err) {
      return $q.reject(err);
    }
  };

  this.convertDataPointsToMs = function(result) {
    if (!result || !result.data) { return []; }
    for (var i = 0; i < result.data.length; i++) {
      var series = result.data[i];
      for (var y = 0; y < series.datapoints.length; y++) {
        series.datapoints[y][1] *= 1000;
      }
    }
    return result;
  };

  this.annotationQuery = function(options) {
    // Graphite metric as annotation
    if (options.annotation.target) {
      var target = templateSrv.replace(options.annotation.target, {}, 'glob');
      var graphiteQuery = {
        rangeRaw: options.rangeRaw,
        targets: [{ target: target }],
        format: 'json',
        maxDataPoints: 100
      };

      return this.query(graphiteQuery).then(function(result) {
        var list = [];

        for (var i = 0; i < result.data.length; i++) {
          var target = result.data[i];

          for (var y = 0; y < target.datapoints.length; y++) {
            var datapoint = target.datapoints[y];
            if (!datapoint[0]) { continue; }

            list.push({
              annotation: options.annotation,
              time: datapoint[1],
              title: target.target
            });
          }
        }

        return list;
      });
    } else {
      // Graphite event as annotation
      var tags = templateSrv.replace(options.annotation.tags);
      return this.events({range: options.rangeRaw, tags: tags}).then(function(results) {
        var list = [];
        for (var i = 0; i < results.data.length; i++) {
          var e = results.data[i];

          list.push({
            annotation: options.annotation,
            time: e.when * 1000,
            title: e.what,
            tags: e.tags,
            text: e.data
          });
        }
        return list;
      });
    }
  };

  this.events = function(options) {
    try {
      var tags = '';
      if (options.tags) {
        tags = '&tags=' + options.tags;
      }

      return this.doGraphiteRequest({
        method: 'GET',
        url: '/events/get_data?from=' + this.translateTime(options.range.from, false) +
          '&until=' + this.translateTime(options.range.to, true) + tags,
      });
    } catch (err) {
      return $q.reject(err);
    }
  };

  this.translateTime = function(date, roundUp) {
    if (_.isString(date)) {
      if (date === 'now') {
        return 'now';
      } else if (date.indexOf('now-') >= 0 && date.indexOf('/') === -1) {
        date = date.substring(3);
        date = date.replace('m', 'min');
        date = date.replace('M', 'mon');
        return date;
      }
      date = dateMath.parse(date, roundUp);
    }

    // graphite' s from filter is exclusive
    // here we step back one minute in order
    // to guarantee that we get all the data that
    // exists for the specified range
    if (roundUp) {
      if (date.get('s')) {
        date.add(1, 'm');
      }
    } else if (roundUp === false) {
      if (date.get('s')) {
        date.subtract(1, 'm');
      }
    }

    return date.unix();
  };

  this.metricFindQuery = function(query) {
    var interpolated;
    try {
      interpolated = encodeURIComponent(templateSrv.replace(query));
    } catch (err) {
      return $q.reject(err);
    }

    return this.doGraphiteRequest({method: 'GET', url: '/metrics/find/?query=' + interpolated })
    .then(function(results) {
      return _.map(results.data, function(metric) {
        return {
          text: metric.text,
          expandable: metric.expandable ? true : false
        };
      });
    });
  };

  this.testDatasource = function() {
    return this.metricFindQuery('*').then(function () {
      return { status: "success", message: "Data source is working", title: "Success" };
    });
  };

  this.listDashboards = function(query) {
    return this.doGraphiteRequest({ method: 'GET',  url: '/dashboard/find/', params: {query: query || ''} })
    .then(function(results) {
      return results.data.dashboards;
    });
  };

  this.loadDashboard = function(dashName) {
    return this.doGraphiteRequest({method: 'GET', url: '/dashboard/load/' + encodeURIComponent(dashName) });
  };

  this.doGraphiteRequest = function(options) {
    if (this.basicAuth || this.withCredentials) {
      options.withCredentials = true;
    }
    if (this.basicAuth) {
      options.headers = options.headers || {};
      options.headers.Authorization = this.basicAuth;
    }

    options.url = this.url + options.url;
    options.inspect = { type: 'graphite' };

    return backendSrv.datasourceRequest(options);
  };

  this._seriesRefLetters = 'ABCDEFGHIJKLMNOPQRSTUVWXYZ';

  this.buildGraphiteParams = function(options, scopedVars) {
    var graphite_options = ['from', 'until', 'rawData', 'format', 'maxDataPoints', 'cacheTimeout'];
    var clean_options = [], targets = {};
    var target, targetValue, i;
    var regex = /\#([A-Z])/g;
    var intervalFormatFixRegex = /'(\d+)m'/gi;
    var hasTargets = false;

    if (options.format !== 'png') {
      options['format'] = 'json';
    }

    function fixIntervalFormat(match) {
      return match.replace('m', 'min').replace('M', 'mon');
    }

    for (i = 0; i < options.targets.length; i++) {
      target = options.targets[i];
      if (!target.target) {
        continue;
      }

      if (!target.refId) {
        target.refId = this._seriesRefLetters[i];
      }

      targetValue = templateSrv.replace(target.target, scopedVars);
      targetValue = targetValue.replace(intervalFormatFixRegex, fixIntervalFormat);
      targets[target.refId] = targetValue;
    }

    function nestedSeriesRegexReplacer(match, g1) {
      return targets[g1];
    }

    for (i = 0; i < options.targets.length; i++) {
      target = options.targets[i];
      if (!target.target) {
        continue;
      }

      targetValue = targets[target.refId];
      targetValue = targetValue.replace(regex, nestedSeriesRegexReplacer);
      targets[target.refId] = targetValue;

      if (!target.hide) {
        hasTargets = true;
        clean_options.push("target=" + encodeURIComponent(targetValue));
      }
    }

    _.each(options, function (value, key) {
      if (_.indexOf(graphite_options, key) === -1) { return; }
      if (value) {
        clean_options.push(key + "=" + encodeURIComponent(value));
      }
    });

    if (!hasTargets) {
      return [];
    }

    return clean_options;
  };
}