LoadMonitor.h

//------------------------------------------------------------------------------
/*
    This file is part of rippled: https://github.com/ripple/rippled
    Copyright (c) 2012, 2013 Ripple Labs Inc.
 
    Permission to use, copy, modify, and/or distribute this software for any
    purpose  with  or without fee is hereby granted, provided that the above
    copyright notice and this permission notice appear in all copies.
 
    THE  SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
    WITH  REGARD  TO  THIS  SOFTWARE  INCLUDING  ALL  IMPLIED  WARRANTIES  OF
    MERCHANTABILITY  AND  FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
    ANY  SPECIAL ,  DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
    WHATSOEVER  RESULTING  FROM  LOSS  OF USE, DATA OR PROFITS, WHETHER IN AN
    ACTION  OF  CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
    OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
*/
//==============================================================================
 
#ifndef RIPPLE_CORE_LOADMONITOR_H_INCLUDED
#define RIPPLE_CORE_LOADMONITOR_H_INCLUDED
 
#include <xrpld/core/LoadEvent.h>
 
#include <xrpl/basics/UptimeClock.h>
#include <xrpl/beast/utility/Journal.h>
 
#include <chrono>
#include <mutex>
 
namespace ripple {
 
// Monitors load levels and response times
 
// VFALCO TODO Rename this. Having both LoadManager and LoadMonitor is
// confusing.
//
class LoadMonitor
{
public:
    explicit LoadMonitor(beast::Journal j);
 
    void
    addLoadSample(LoadEvent const& sample);
 
    void
    addSamples(int count, std::chrono::milliseconds latency);
 
    void
    setTargetLatency(
        std::chrono::milliseconds avg,
        std::chrono::milliseconds pk);
 
    bool
    isOverTarget(std::chrono::milliseconds avg, std::chrono::milliseconds peak);
 
    // VFALCO TODO make this return the values in a struct.
    struct Stats
    {
        Stats();
 
        std::uint64_t count;
        std::chrono::milliseconds latencyAvg;
        std::chrono::milliseconds latencyPeak;
        bool isOverloaded;
    };
 
    Stats
    getStats();
 
    bool
    isOver();
 
private:
    void
    update();
 
    std::mutex mutex_;
 
    std::uint64_t mCounts;
    int mLatencyEvents;
    std::chrono::milliseconds mLatencyMSAvg;
    std::chrono::milliseconds mLatencyMSPeak;
    std::chrono::milliseconds mTargetLatencyAvg;
    std::chrono::milliseconds mTargetLatencyPk;
    UptimeClock::time_point mLastUpdate;
    beast::Journal const j_;
};
 
}  // namespace ripple
 
#endif