ClickHouse/dbms/include/DB/Common/CurrentMetrics.h

142 lines
3.5 KiB
C++
Raw Normal View History

#pragma once
#include <cstdint>
#include <utility>
2016-07-31 03:53:16 +00:00
#include <atomic>
/** Позволяет считать количество одновременно происходящих событий или текущее значение какой-либо метрики.
* - для высокоуровневого профайлинга.
*
* Также смотрите ProfileEvents.h
* В ProfileEvents считается общее количество произошедших (точечных) событий - например, сколько раз были выполнены запросы.
* В CurrentMetrics считается количество одновременных событий - например, сколько сейчас одновременно выполняется запросов,
* или текущее значение метрики - например, величина отставания реплики в секундах.
*/
#define APPLY_FOR_METRICS(M) \
M(Query) \
M(Merge) \
M(ReplicatedFetch) \
M(ReplicatedSend) \
M(ReplicatedChecks) \
M(BackgroundPoolTask) \
M(DiskSpaceReservedForMerge) \
M(DistributedSend) \
M(QueryPreempted) \
M(TCPConnection) \
M(HTTPConnection) \
M(InterserverConnection) \
M(OpenFileForRead) \
M(OpenFileForWrite) \
M(Read) \
M(Write) \
M(SendExternalTables) \
M(QueryThread) \
M(ReadonlyReplica) \
M(MemoryTracking) \
\
M(END)
namespace CurrentMetrics
{
/// Виды метрик.
enum Metric
{
#define M(NAME) NAME,
APPLY_FOR_METRICS(M)
#undef M
};
/// Получить текстовое описание метрики по его enum-у.
inline const char * getDescription(Metric event)
{
static const char * descriptions[] =
{
#define M(NAME) #NAME,
APPLY_FOR_METRICS(M)
#undef M
};
return descriptions[event];
}
using Value = int64_t;
/// Счётчики - текущие значения метрик.
2016-07-31 03:53:16 +00:00
extern std::atomic<Value> values[END];
/// Выставить значение указанной метрики.
inline void set(Metric metric, Value value)
{
values[metric] = value;
}
/// Прибавить величину к значению указанной метрики. Вы затем должны вычесть величину самостоятельно. Или см. ниже class Increment.
inline void add(Metric metric, Value value = 1)
{
2016-07-31 03:53:16 +00:00
values[metric] += value;
}
inline void sub(Metric metric, Value value = 1)
{
add(metric, -value);
}
/// На время жизни объекта, увеличивает указанное значение на указанную величину.
class Increment
{
private:
2016-07-31 03:53:16 +00:00
std::atomic<Value> * what;
Value amount;
2016-07-31 03:53:16 +00:00
Increment(std::atomic<Value> * what, Value amount)
: what(what), amount(amount)
{
2016-07-31 03:53:16 +00:00
*what += amount;
}
public:
Increment(Metric metric, Value amount = 1)
: Increment(&values[metric], amount) {}
~Increment()
{
if (what)
2016-07-31 03:53:16 +00:00
*what -= amount;
}
Increment(Increment && old)
{
*this = std::move(old);
}
Increment & operator= (Increment && old)
{
what = old.what;
amount = old.amount;
old.what = nullptr;
return *this;
}
void changeTo(Value new_amount)
{
2016-07-31 03:53:16 +00:00
*what += new_amount - amount;
amount = new_amount;
}
/// Уменьшить значение раньше вызова деструктора.
void destroy()
{
2016-07-31 03:53:16 +00:00
*what -= amount;
what = nullptr;
}
};
}
#undef APPLY_FOR_METRICS