Giter Club home page Giter Club logo

capacitor's Introduction

Capacitor (WIP: WARNING! DO NOT USE)

Capacitor is a load shedding engine with integrated QoS and fairness. It allows us to continuosly monitor a set of metrics about the capacity of our system and react to them in real time to keep system load controlled by rejecting traffic that would otherwise kill the service.

Capacitor is designed for multitenancy services, keeping fairness as one of the main objetives

Usage

const capacitor = require('capacitor');

const server = capacitor(expressServer);

server.get('...').loadShedding({
  flowPosition: capacitor.FLOW_POSITION.START,
  endpointClass: capacitor.ENDPOINT_CLASS.BUSINESS_CRITICAL,
  directCost: capacitor.COST_CLASSES.LOW
});

const shedder = capacitor.build({
  limits: {
    cpu: {
      softLimit: 0.75,
      hardLimit: 0.8
      fn: capacitor.cost.cpu
    },
    eventLoop: {
      softLimit: 100,
      hardLimit: 150,
      fn: capacitor.cost.eventLoopLag
    }
  },

  opportunityCost: (reqData) => {
    // Example /test endpoint from LB
    if (reqData.endpointClass === capacitor.ENDPOINT_CLASS.INFRA_CRITICAL) {
      return capacitor.COST_CLASSES.EXTREMELY_HIGH;
    }

    if (reqData.payingTier === 'enterprice' && reqData.usageTier === 'production') {
      if (reqData.endpointClass === capacitor.ENDPOINT_CLASS.BUSINESS_CRITICAL) {
        return reqData.entityRPS < 100 ? capacitor.COST_CLASSES.HIGH : capacitor.COST_CLASSES.MEDIUM;
      }

      // If we have started an operation better to finish it than having the user
      // retry the whole flow adding more load to the system
      if (reqData.flowPosition === capacitor.FLOW_POSITION.INTERMEDIATE) {
        return capacitor.COST_CLASSES.MEDIUM;
      }

      return capacitor.COST_CLASSES.LOW;
    }

    return capacitor.COST_CLASSES.LOW;
  }

  directCost: (reqData) => {
    return reqData.requestDirectCost;
  },

  resolveEntity: (reqData) => {
    return reqData.tenant;
  },

  fairnessLimit: 0.10,

  requestClassifier: (directCost, oportunityCost) => {
    if (oportunityCost > directCost) {
      return capacitor.REQUEST_CLASSES.HIGH;
    }

    if (oportunityCost === directCost) {
      return capacitor.REQUEST_CLASSES.MEDIUM;
    }

    if (oportunityCost < directCost) {
      return capacitor.REQUEST_CLASSES.LOW;
    }
  }
});

capacitor's People

Contributors

dafortune avatar

Watchers

 avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.