Singleton class that maintains performance counters and optionally writes Json-formatted data to a distinct log. More...

#include <PerfLog.h>

Inheritance diagram for ripple::perf::PerfLog:

[legend]

Classes
struct	Setup
	Configuration from [perf] section of rippled.cfg. More...

Public Types
using	steady_clock = std::chrono::steady_clock

using	system_clock = std::chrono::system_clock

using	steady_time_point = std::chrono::time_point< steady_clock >

using	system_time_point = std::chrono::time_point< system_clock >

using	seconds = std::chrono::seconds

using	milliseconds = std::chrono::milliseconds

using	microseconds = std::chrono::microseconds

Public Member Functions
virtual	~PerfLog ()=default

virtual void	start ()

virtual void	stop ()

virtual void	rpcStart (std::string const &method, std::uint64_t requestId)=0
	Log start of RPC call.

virtual void	rpcFinish (std::string const &method, std::uint64_t requestId)=0
	Log successful finish of RPC call.

virtual void	rpcError (std::string const &method, std::uint64_t requestId)=0
	Log errored RPC call.

virtual void	jobQueue (JobType const type)=0
	Log queued job.

virtual void	jobStart (JobType const type, microseconds dur, steady_time_point startTime, int instance)=0
	Log job executing.

virtual void	jobFinish (JobType const type, microseconds dur, int instance)=0
	Log job finishing.

virtual Json::Value	countersJson () const =0
	Render performance counters in Json.

virtual Json::Value	currentJson () const =0
	Render currently executing jobs and RPC calls and durations in Json.

virtual void	resizeJobs (int const resize)=0
	Ensure enough room to store each currently executing job.

virtual void	rotate ()=0
	Rotate perf log file.

Detailed Description

Singleton class that maintains performance counters and optionally writes Json-formatted data to a distinct log.

It should exist prior to other objects launched by Application to make it accessible for performance logging.

Definition at line 32 of file PerfLog.h.

Member Typedef Documentation

◆ steady_clock

using ripple::perf::PerfLog::steady_clock = std::chrono::steady_clock

Definition at line 35 of file PerfLog.h.

◆ system_clock

using ripple::perf::PerfLog::system_clock = std::chrono::system_clock

Definition at line 36 of file PerfLog.h.

◆ steady_time_point

using ripple::perf::PerfLog::steady_time_point = std::chrono::time_point<steady_clock>

Definition at line 37 of file PerfLog.h.

◆ system_time_point

using ripple::perf::PerfLog::system_time_point = std::chrono::time_point<system_clock>

Definition at line 38 of file PerfLog.h.

◆ seconds

using ripple::perf::PerfLog::seconds = std::chrono::seconds

Definition at line 39 of file PerfLog.h.

◆ milliseconds

using ripple::perf::PerfLog::milliseconds = std::chrono::milliseconds

Definition at line 40 of file PerfLog.h.

◆ microseconds

using ripple::perf::PerfLog::microseconds = std::chrono::microseconds

Definition at line 41 of file PerfLog.h.

Constructor & Destructor Documentation

◆ ~PerfLog()

virtual ripple::perf::PerfLog::~PerfLog ( )

virtualdefault

Member Function Documentation

◆ start()

virtual void ripple::perf::PerfLog::start ( )

virtual

Reimplemented in ripple::perf::PerfLogImp.

Definition at line 56 of file PerfLog.h.

◆ stop()

virtual void ripple::perf::PerfLog::stop ( )

virtual

Reimplemented in ripple::perf::PerfLogImp.

Definition at line 61 of file PerfLog.h.

◆ rpcStart()

virtual void ripple::perf::PerfLog::rpcStart	(	std::string const &	method,
		std::uint64_t	requestId
	)

pure virtual

Log start of RPC call.

Parameters

method	RPC command
requestId	Unique identifier to track command

Implemented in ripple::perf::PerfLogImp, and ripple::perf::PerfLogTest.

◆ rpcFinish()

virtual void ripple::perf::PerfLog::rpcFinish	(	std::string const &	method,
		std::uint64_t	requestId
	)

pure virtual

Log successful finish of RPC call.

Parameters

method	RPC command
requestId	Unique identifier to track command

Implemented in ripple::perf::PerfLogImp, and ripple::perf::PerfLogTest.

◆ rpcError()

virtual void ripple::perf::PerfLog::rpcError	(	std::string const &	method,
		std::uint64_t	requestId
	)

pure virtual

Log errored RPC call.

Parameters

method	RPC command
requestId	Unique identifier to track command

Implemented in ripple::perf::PerfLogImp, and ripple::perf::PerfLogTest.

◆ jobQueue()

virtual void ripple::perf::PerfLog::jobQueue ( JobType const type )

pure virtual

Log queued job.

Parameters

type Job type

Implemented in ripple::perf::PerfLogTest, and ripple::perf::PerfLogImp.

◆ jobStart()

virtual void ripple::perf::PerfLog::jobStart	(	JobType const	type,
		microseconds	dur,
		steady_time_point	startTime,
		int	instance
	)

pure virtual

Log job executing.

Parameters

type	Job type
dur	Duration enqueued in microseconds
startTime	Time that execution began
instance	JobQueue worker thread instance

Implemented in ripple::perf::PerfLogImp.

◆ jobFinish()

virtual void ripple::perf::PerfLog::jobFinish	(	JobType const	type,
		microseconds	dur,
		int	instance
	)

pure virtual

Log job finishing.

Parameters

type	Job type
dur	Duration running in microseconds
instance	Jobqueue worker thread instance

Implemented in ripple::perf::PerfLogImp, and ripple::perf::PerfLogTest.

◆ countersJson()

virtual Json::Value ripple::perf::PerfLog::countersJson ( ) const

pure virtual

Render performance counters in Json.

Returns: Counters Json object

Implemented in ripple::perf::PerfLogTest, and ripple::perf::PerfLogImp.

◆ currentJson()

virtual Json::Value ripple::perf::PerfLog::currentJson ( ) const

pure virtual

Render currently executing jobs and RPC calls and durations in Json.

Returns: Current executing jobs and RPC calls and durations

Implemented in ripple::perf::PerfLogTest, and ripple::perf::PerfLogImp.

◆ resizeJobs()

virtual void ripple::perf::PerfLog::resizeJobs ( int const resize )

pure virtual

Ensure enough room to store each currently executing job.

Parameters

resize Number of JobQueue worker threads

Implemented in ripple::perf::PerfLogTest, and ripple::perf::PerfLogImp.

◆ rotate()

virtual void ripple::perf::PerfLog::rotate ( )

pure virtual

Rotate perf log file.

Implemented in ripple::perf::PerfLogTest, and ripple::perf::PerfLogImp.

Classes

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ steady_clock

◆ system_clock

◆ steady_time_point

◆ system_time_point

◆ seconds

◆ milliseconds

◆ microseconds

Constructor & Destructor Documentation

◆ ~PerfLog()

Member Function Documentation

◆ start()

◆ stop()

◆ rpcStart()

◆ rpcFinish()

◆ rpcError()

◆ jobQueue()

◆ jobStart()

◆ jobFinish()

◆ countersJson()

◆ currentJson()

◆ resizeJobs()

◆ rotate()