clio/src/rpc/Counters.h

//------------------------------------------------------------------------------
/*
    This file is part of clio: https://github.com/XRPLF/clio
    Copyright (c) 2022, the clio developers.

    Permission to use, copy, modify, and 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.
*/
//==============================================================================

#pragma once

#include "rpc/WorkQueue.h"
#include "util/prometheus/Counter.h"

#include <boost/json.hpp>
#include <boost/json/object.hpp>

#include <chrono>
#include <functional>
#include <mutex>
#include <string>
#include <unordered_map>

namespace rpc {

/**
 * @brief Holds information about successful, failed, forwarded, etc. RPC handler calls.
 */
class Counters {
    using CounterType = std::reference_wrapper<util::prometheus::CounterInt>;
    /**
     * @brief All counters the system keeps track of for each RPC method.
     */
    struct MethodInfo {
        MethodInfo(std::string const& method);

        CounterType started;
        CounterType finished;
        CounterType failed;
        CounterType errored;
        CounterType forwarded;
        CounterType failedForward;
        CounterType duration;
    };

    MethodInfo&
    getMethodInfo(std::string const& method);

    mutable std::mutex mutex_;
    std::unordered_map<std::string, MethodInfo> methodInfo_;

    // counters that don't carry RPC method information
    CounterType tooBusyCounter_;
    CounterType notReadyCounter_;
    CounterType badSyntaxCounter_;
    CounterType unknownCommandCounter_;
    CounterType internalErrorCounter_;

    std::reference_wrapper<WorkQueue const> workQueue_;
    std::chrono::time_point<std::chrono::system_clock> startupTime_;

public:
    /**
     * @brief Creates a new counters instance that operates on the given WorkQueue.
     *
     * @param wq The work queue to operate on
     */
    Counters(WorkQueue const& wq);

    /**
     * @brief A factory function that creates a new counters instance.
     *
     * @param wq The work queue to operate on
     * @return The new instance
     */
    static Counters
    make_Counters(WorkQueue const& wq)
    {
        return Counters{wq};
    }

    /**
     * @brief Increments the failed count for a particular RPC method.
     *
     * @param method The method to increment the count for
     */
    void
    rpcFailed(std::string const& method);

    /**
     * @brief Increments the errored count for a particular RPC method.
     *
     * @param method The method to increment the count for
     */
    void
    rpcErrored(std::string const& method);

    /**
     * @brief Increments the completed count for a particular RPC method.
     *
     * @param method The method to increment the count for
     */
    void
    rpcComplete(std::string const& method, std::chrono::microseconds const& rpcDuration);

    /**
     * @brief Increments the forwarded count for a particular RPC method.
     *
     * @param method The method to increment the count for
     */
    void
    rpcForwarded(std::string const& method);

    /**
     * @brief Increments the failed to forward count for a particular RPC method.
     *
     * @param method The method to increment the count for
     */
    void
    rpcFailedToForward(std::string const& method);

    /** @brief Increments the global too busy counter. */
    void
    onTooBusy();

    /** @brief Increments the global not ready counter. */
    void
    onNotReady();

    /** @brief Increments the global bad syntax counter. */
    void
    onBadSyntax();

    /** @brief Increments the global unknown command/method counter. */
    void
    onUnknownCommand();

    /** @brief Increments the global internal error counter. */
    void
    onInternalError();

    /** @return Uptime of this instance in seconds. */
    std::chrono::seconds
    uptime() const;

    /** @return A JSON report with current state of all counters for every method. */
    boost::json::object
    report() const;
};

}  // namespace rpc