Metric.h File Reference

#include "Define.h"
#include "Duration.h"
#include "MPSCQueue.h"
#include "Optional.h"
#include <boost/container/small_vector.hpp>
#include <functional>
#include <iosfwd>
#include <memory>
#include <string>
#include <unordered_map>
#include <utility>

Include dependency graph for Metric.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Classes
struct	MetricData
class	Metric
class	MetricStopWatch< LoggerType >

Namespaces
namespace	Trinity
namespace	Trinity::Asio

Macros
#define	sMetric   Metric::instance()
#define	TC_METRIC_TAG(name, value)   MetricTag(name, value)
#define	TC_METRIC_DO_CONCAT(a, b)   a ## b
#define	TC_METRIC_CONCAT(a, b)   TC_METRIC_DO_CONCAT(a, b)
#define	TC_METRIC_UNIQUE_NAME(name)   TC_METRIC_CONCAT(name, __LINE__)
#define	TC_METRIC_EVENT(category, title, description)
#define	TC_METRIC_VALUE(category, value, ...)
#define	TC_METRIC_TIMER(category, ...)
#define	TC_METRIC_DETAILED_EVENT(category, title, description)   ((void)0)
#define	TC_METRIC_DETAILED_TIMER(category, ...)   ((void)0)
#define	TC_METRIC_DETAILED_NO_THRESHOLD_TIMER(category, ...)   ((void)0)

Typedefs
using	MetricTag = std::pair< std::string, std::string >
using	MetricTagsVector = boost::container::small_vector< MetricTag, 2 >

Enumerations
enum	MetricDataType { METRIC_DATA_VALUE , METRIC_DATA_EVENT }

Functions
template<typename LoggerType >
Optional< MetricStopWatch< LoggerType > >	MakeMetricStopWatch (LoggerType &&loggerFunc)

Macro Definition Documentation

sMetric

#define sMetric   Metric::instance()

Definition at line 138 of file Metric.h.

TC_METRIC_CONCAT

#define TC_METRIC_CONCAT	(		a,
			b
	)		TC_METRIC_DO_CONCAT(a, b)

Definition at line 172 of file Metric.h.

TC_METRIC_DETAILED_EVENT

#define TC_METRIC_DETAILED_EVENT	(		category,
			title,
			description
	)		((void)0)

Definition at line 229 of file Metric.h.

TC_METRIC_DETAILED_NO_THRESHOLD_TIMER

#define TC_METRIC_DETAILED_NO_THRESHOLD_TIMER	(		category,
			...
	)		((void)0)

Definition at line 231 of file Metric.h.

TC_METRIC_DETAILED_TIMER

#define TC_METRIC_DETAILED_TIMER	(		category,
			...
	)		((void)0)

Definition at line 230 of file Metric.h.

TC_METRIC_DO_CONCAT

#define TC_METRIC_DO_CONCAT	(		a,
			b
	)		a ## b

Definition at line 171 of file Metric.h.

TC_METRIC_EVENT

#define TC_METRIC_EVENT	(		category,
			title,
			description
	)

Value:

        __pragma(warning(push))                                        \
        __pragma(warning(disable:4127))                                \
        do {                                                           \
            if (sMetric->IsEnabled())                                  \
                sMetric->LogEvent(category, title, description);       \
        } while (0)                                                    \
        __pragma(warning(pop))

Definition at line 195 of file Metric.h.

TC_METRIC_TAG

#define TC_METRIC_TAG	(		name,
			value
	)		MetricTag(name, value)

Definition at line 169 of file Metric.h.

TC_METRIC_TIMER

#define TC_METRIC_TIMER	(		category,
			...
	)

Value:

        auto TC_METRIC_UNIQUE_NAME(__tc_metric_stop_watch) = MakeMetricStopWatch([&](TimePoint start)            \
        {                                                                                                        \
            sMetric->LogValue(category, std::chrono::steady_clock::now() - start, ##__VA_ARGS__);                \
        });

Definition at line 212 of file Metric.h.

TC_METRIC_UNIQUE_NAME

#define TC_METRIC_UNIQUE_NAME

(

name

)

TC_METRIC_CONCAT(name, __LINE__)

Definition at line 173 of file Metric.h.

TC_METRIC_VALUE

#define TC_METRIC_VALUE	(		category,
			value,
			...
	)

Value:

        __pragma(warning(push))                                        \
        __pragma(warning(disable:4127))                                \
        do {                                                           \
            if (sMetric->IsEnabled())                                  \
                sMetric->LogValue(category, value, ##__VA_ARGS__);     \
        } while (0)                                                    \
        __pragma(warning(pop))

Definition at line 203 of file Metric.h.

Typedef Documentation

MetricTag

using MetricTag = std::pair<std::string, std::string>

Definition at line 48 of file Metric.h.

MetricTagsVector

using MetricTagsVector = boost::container::small_vector<MetricTag, 2>

Definition at line 49 of file Metric.h.

Enumeration Type Documentation

MetricDataType

enum MetricDataType

Enumerator
METRIC_DATA_VALUE
METRIC_DATA_EVENT

Definition at line 42 of file Metric.h.

Function Documentation

MakeMetricStopWatch()

template<typename LoggerType >

Optional< MetricStopWatch< LoggerType > > MakeMetricStopWatch

(

LoggerType &&

loggerFunc

)

Definition at line 161 of file Metric.h.