apigee-edge-js/lib/stat.js

nodejs library for the administration API for Apigee (Edge and X and hybrid).

// stats.js
// ------------------------------------------------------------------
//
// created: Mon Oct 15 17:23:24 2018
// last saved: <2023-December-12 15:41:22>

/* jshint esversion:9, node:true, strict:implied */

const common = require("./common.js"),
  utility = require("./utility.js"),
  promiseWrap = require("./promiseWrap.js"),
  urljoin = require("url-join"),
  sprintf = require("sprintf-js").sprintf,
  request = require("postman-request"),
  dateFormat = require("dateformat");

function utcOffset_apigeeTimeFormat(date) {
  const s = dateFormat(date, "isoUtcDateTime");
  s = s.slice(0, -4);
  return s.slice(-5);
}

function getTimeRange(start, end) {
  start =
    dateFormat(start, "mm/dd/yyyy") + " " + utcOffset_apigeeTimeFormat(start);
  end = dateFormat(end, "mm/dd/yyyy") + " " + utcOffset_apigeeTimeFormat(end);
  return start + "~" + end;
}

function Stat(conn) {
  this.conn = conn;
}

Stat.prototype.get = promiseWrap(function (options, cb) {
  // GET "$mgmtserver/v1/o/$ORG/e/$ENV/stats/apis?select=sum(message_count)&timeRange=01/01/2018%2000:00~08/01/2018%2000:00&timeUnit=month"

  // var options = {
  //       environment : 'test',
  //       dimension: 'apis',
  //       metric: 'sum(message_count)',
  //       startTime: startTime,
  //       endTime : endTime,
  //       timeUnit : 'month',
  //       limit : 1024,
  //       optimize : true/false,
  //       cacheCheck : fn
  //     };

  if (!cb) {
    cb = options;
    options = {};
  }
  const conn = this.conn;
  const env = options.environmentName || options.environment;
  if (!env) {
    throw new Error("missing environment name");
  }
  if (!options.dimension) {
    throw new Error("missing dimension");
  }
  if (!options.metric) {
    throw new Error("missing metric");
  }
  common.insureFreshToken(conn, function (requestOptions) {
    let query = sprintf(
      "?select=%s&timeUnit=%s&timeRange=%s",
      options.metric,
      options.timeUnit,
      getTimeRange(options.startTime, options.endTime)
    );

    if (options.limit) {
      query += "&limit=" + options.limit;
    }
    if (options.optimize) {
      query += "&_optimize=js";
    }
    if (options.metric.indexOf("percentile") >= 0) {
      query += "&t=agg_percentile";
    }
    if (options.filter) {
      // filter=(apiproxy%20eq%20%%27${APIPROXY}%27)
      query += "&filter=" + options.filter;
    }
    requestOptions.url =
      urljoin(conn.urlBase, "environments", env, "stats", options.dimension) +
      query;

    if (conn.verbosity > 0) {
      utility.logWrite(sprintf("GET %s", requestOptions.url));
    }

    // it takes a long time to retrieve some stats data. So let's
    // allow the use of a cache via an upcall.
    if (typeof options.cacheCheck == "function") {
      const uniquifier = sprintf(
        "%s-%s-%s-%s-%s-%s-%s",
        conn.orgname,
        env,
        options.dimension,
        options.metric,
        dateFormat(options.startTime, "yyyymmdd"),
        dateFormat(options.endTime, "yyyymmdd"),
        options.timeUnit
      );
      const cacheResponse = options.cacheCheck(requestOptions.url, uniquifier);
      if (cacheResponse) {
        if (cacheResponse.data) {
          return cb(null, { data: JSON.parse(cacheResponse.data) });
        } else if (cacheResponse.cachefile) {
          return request.get(
            requestOptions,
            common.callback(conn, [200], function (e, data) {
              cb(e, { cachefile: cacheResponse.cachefile, data: data });
            })
          );
        }
      }
    }
    return request.get(
      requestOptions,
      common.callback(conn, [200], function (e, data) {
        cb(e, { data: data });
      })
    );
  });
});

module.exports = Stat;