monitor.js

// Copyright (c) 2020 Uber Technologies, Inc.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.

'use strict';

var format = require('util').format;
var inherits = require('util').inherits;
var console = require('console');

module.exports.ChanConnMonitor = ChanConnMonitor;

function ChanConnMonitor(channel, options) {
    this.options = options;
    this.channel = channel;
    this.interval = options.interval;
    this.byBucket = options.byBucket;
    this.byTTL = options.byTTL;
    this.timers = channel.timers;
    this.timer = null;
    this.running = false;

    if (options.eachConn) {
        this.eachConn = options.eachConn;
    }
    if (options.summary) {
        this.summary = options.summary;
    }
    if (options.log) {
        this.log = options.log;
    }
}

/*eslint-disable no-console*/
ChanConnMonitor.prototype.log = console.log;
/*eslint-enable no-console*/

ChanConnMonitor.prototype.summary = function summary() {
};

ChanConnMonitor.prototype.run = function run() {
    var self = this;

    if (self.channel.destroyed) {
        return;
    }

    self.running = true;
    self.timer = self.timers.setTimeout(tickMe, self.interval);

    function tickMe() {
        self.tick();
    }
};

ChanConnMonitor.prototype.tick = function tick() {
    var self = this;

    self.timers.clearTimeout(self.timer);
    self.timer = null;

    if (!self.running) {
        return;
    }

    if (self.channel.destroyed) {
        self.running = false;
        return;
    }

    if (self.eachConn) {
        self.channel.peers.values().forEach(eachPeer);
        if (self.channel.serverConnections) {
            Object.keys(self.channel.serverConnections).forEach(eashServerConn);
        }
    }

    self.summary({
        channel: self.channel
    });

    self.timer = self.timers.setTimeout(tockMe, self.interval);

    function eashServerConn(addr) {
        var conn = self.channel.serverConnections[addr];
        var connDesc = format('serverConn[%s]', addr);
        self.eachConn({
            channel: self.channel,
            peer: null,
            peerDesc: '',
            conn: conn,
            connDesc: connDesc
        });
    }

    function eachPeer(peer, j) {
        var peerDesc = format('peer[%s]', j);
        peer.connections.forEach(function eachConn(conn, k) {
            var connDesc = format('conn[%s]', k);
            self.eachConn({
                channel: self.channel,
                peer: peer,
                peerDesc: peerDesc,
                conn: conn,
                connDesc: connDesc
            });
        });
    }

    function tockMe() {
        self.tick();
    }
};

module.exports.OpKindMonitor = OpKindMonitor;

function OpKindMonitor(channel, options) {
    ChanConnMonitor.call(this, channel, options);
    this.inCounts = [];
    this.outCounts = [];
}

inherits(OpKindMonitor, ChanConnMonitor);

OpKindMonitor.prototype.eachConn = function eachConn(stuff) {
    var self = this;

    var conn = stuff.conn;
    var desc = conn.connDesc;
    if (conn.peerDesc) {
        desc = conn.peerDesc + ' ';
    }
    desc = format('relay %s %s', stuff.channel.hostPort, desc);

    var inKeys = Object.keys(conn.ops.requests.in);
    if (inKeys.length) {
        var inCount = countConstructors(conn.ops.requests.in);
        self.inCounts.push(inCount);
    }

    var outKeys = Object.keys(conn.ops.requests.out);
    if (outKeys.length) {
        var outCount = countConstructors(conn.ops.requests.out);
        self.outCounts.push(outCount);
    }
};

OpKindMonitor.prototype.summary = function summary() {
    var self = this;

    if (self.inCounts.length) {
        self.log('= %s IN COUNTS: %j',
                    self.options.desc,
                    self.inCounts.reduce(sumCounts, {}));
        self.inCounts.length = 0;
    }

    if (self.outCounts.length && self.byBucket) {
        self.log('= %s OUT COUNTS BY BUCKET: %j',
            self.options.desc,
            reduceByBucket(self.outCounts, self.byBucket));
    }

    if (self.outCounts.length && self.byTTL) {
        self.log('= %s OUT COUNTS BY TTL: %j',
            self.options.desc,
            reduceByTTL(self.outCounts));
    }

    if (self.outCounts.length) {
        self.log('= %s OUT COUNTS: %j',
                    self.options.desc,
                    self.outCounts.reduce(sumCounts, {}));
        self.outCounts.length = 0;
    }
};

function reduceByBucket(list) {
    var info = {};

    for (var i = 0; i < list.length; i++) {
        var constrs = list[i];

        var keys = Object.keys(constrs);
        for (var j = 0; j < keys.length; j++) {
            var name = keys[j];
            var opCount = constrs[keys[j]];

            if (!info[name]) {
                info[name] = {};
            }

            var bucketKeys = Object.keys(opCount.buckets);
            for (var k = 0; k < bucketKeys.length; k++) {
                var bucketKey = bucketKeys[k];
                if (!info[name][bucketKey]) {
                    info[name][bucketKey] = 0;
                }

                info[name][bucketKey] += opCount.buckets[bucketKey].length;
            }
        }
    }

    return info;
}

function reduceByTTL(list) {
    var info = {};

    for (var i = 0; i < list.length; i++) {
        var constrs = list[i];

        var keys = Object.keys(constrs);
        for (var j = 0; j < keys.length; j++) {
            var name = keys[j];
            var opCount = constrs[keys[j]];

            if (!info[name]) {
                info[name] = {};
            }

            var timeoutKeys = Object.keys(opCount.timeouts);
            for (var k = 0; k < timeoutKeys.length; k++) {
                var timeoutKey = timeoutKeys[k];
                if (!info[name][timeoutKey]) {
                    info[name][timeoutKey] = 0;
                }

                info[name][timeoutKey] += opCount.timeouts[timeoutKey];
            }
        }
    }

    return info;
}

function sumCounts(a, b) {
    Object.keys(b).forEach(function eachB(key) {
        if (!a[key]) {
            a[key] = 0;
        }

        a[key] += b[key].count;
    });
    return a;
}

function countConstructors(obj) {
    var counts = {};
    Object.keys(obj).forEach(function each(prop) {
        var name = obj[prop].constructor.name;
        if (!counts[name]) {
            counts[name] = new OpCount();
        }

        counts[name].push(obj[prop]);
    });
    return counts;
}

function OpCount() {
    this.count = 0;
    this.values = [];
    this.buckets = {};
    this.timeouts = {};
}

OpCount.prototype.push = function push(value) {
    this.count++;
    this.values.push(value);

    if (value.type === 'tchannel.operation.tombstone') {
        var expireTime = value.time + value.timeout;

        var bucketIndex = Math.floor(expireTime / 5000) * 5000;
        if (!this.buckets[bucketIndex]) {
            this.buckets[bucketIndex] = [];
        }
        this.buckets[bucketIndex].push(value);
    }

    if (value.type === 'tchannel.operation.tombstone') {
        var ttl = value.timeout;

        if (!this.timeouts[ttl]) {
            this.timeouts[ttl] = 0;
        }

        this.timeouts[ttl]++;
    }
};