mbvar c++

对mbvar c++版本的快速介绍。

mbvar Introduction

多维度mbvar使用文档

mbvar中有两个类，分别是MVariable和MultiDimension，MVariable是多维度统计的基类，MultiDimension是派生模板类，目前支持如下几种类型：

bvar类型说明
bvar::Adder计数器，默认0，varname « N相当于varname += N。
bvar::Maxer求最大值，默认std::numeric_limits::min()，varname « N相当于varname = max(varname, N)。
bvar::Miner求最小值，默认std::numeric_limits::max()，varname « N相当于varname = min(varname, N)。
bvar::IntRecorder求自使用以来的平均值。注意这里的定语不是“一段时间内”。一般要通过Window衍生出时间窗口内的平均值。
bvar::LatencyRecorder专用于记录延时和qps的变量。输入延时，平均延时/最大延时/qps/总次数 都有了。
bvar::Status记录和显示一个值，拥有额外的set_value函数

例子：

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_count("request_count", {"idc", "method", "status"});
  8. // bvar::MultiDimension<bvar::Adder<int> > g_request_count("foo_bar", "request_count", {"idc", "method", "status"});
  10. int process_request(const std::list<std::string>& request_label) {
  11.     // 获取request_label对应的单维度bvar指针，比如：request_label = {"tc", "get", "200"}
  12.     bvar::Adder<int>* adder = g_request_count.get_stats(request_label);
  13.     // 判断指针非空
  14.     if (!adder) {
  15.         return -1;
  16.     }
  17.     // adder只能在g_request_count的生命周期内访问，否则行为未定义，可能会出core
  18.     // 给adder输入一些值
  19.     *adder << 1 << 2 <<3;
  20.     LOG(INFO) << "adder=" << *adder; // adder add up to 6
  21.     ...
  22.     return 0;
  23. }
  25. } // namespace bar
  26. } // namespace foo

bvar::MVariables

MVariale是MultiDimension(多维度统计)的基类，主要提供全局注册、列举、查询和dump等功能。

expose

expose

用户在创建mbvar变量(bvar::MultiDimension)的时候，如果使用一个参数的构造函数(共有三个构造函数)，这个mbvar并未注册到任何全局结构中(当然也不会dump到本地文件)，在这种情况下，mbvar纯粹是一个更快的多维度计数器。我们称把一个mbvar注册到全局表中的行为为“曝光”，可以通过expose函数曝光：

  1. class MVariable {
  2. public
  3.     ...
  4.     // Expose this mvariable globally so that it's counted in following
  5.     // functions:
  6.     //     list_exposed
  7.     //     count_exposed
  8.     // Return 0 on success, -1 otherwise.
  9.     int expose(const base::StringPiece& name);
  10.     int expose_as(const base::StringPiece& prefix, const base::StringPiece& name);
  11. };

全局曝光后的mbvar名字便为name或者prefix+name，可通过以_exposed为后缀的static函数查询。比如MVariable::describe_exposed(name)会返回名为name的mbvar的描述。

当相同名字的mbvar已存在时，expose会打印FATAL日志并返回-1。如果选项-bvar_abort_on_same_name设为true (默认是false)，程序会直接abort。

下面是一些曝光mbvar的例子：

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_count("request_count", {"idc", "method", "status"});
  9. // 换一个名字
  10. g_request_count->expose("request_count_another");
  12. int process_request(const std::list<std::string>& request_label) {
  13.     // 获取request_label对应的单维度bvar指针，比如：request_label = {"tc", "get", "200"}
  14.     bvar::Adder<int>* adder = g_request_count.get_stats(labels_value);
  15.     // 判断指针非空
  16.     if (!adder) {
  17.         return -1;
  18.     }
  20.     //adder只能在g_request_count的生命周期内访问，否则行为未定义，可能会出core
  21.     *adder << 10 << 20 << 30; // adder add up to 60
  22. }
  24. } // namespace bar
  25. } // namespace foo

expose_as

为了避免重名，mbvar的名字应加上前缀，建议为<namespace>_<module>_<name>。为了方便使用，我们提供了expose_as函数，接收一个前缀。

  1. class MVariable {
  2. public
  3.     ...
  4.     // Expose this mvariable with a prefix.
  5.     // Example:
  6.     //   namespace foo {
  7.     //   namespace bar {
  8.     //
  9.     //      bvar::MultiDimension<bvar::Adder<int> > g_request_count("request_count", {"idc", "method", "status"});
  10.     //      g_request_count.expose_as("foo_bar", "request_count");
  11.     //      ...
  12.     //
  13.     //   }  // foo
  14.     //   }  // bar
  15.     int expose_as(const base::StringPiece& prefix, const base::StringPiece& name);
  16. };

Export all MVariable

提供dump_exposed函数导出进程中所有已曝光的mbvar：

  1. // Implement this class to write mvariables into different places.
  2. // If dump() returns false, MVariable::dump_exposed() skip and continue dump.
  3. class Dumper {
  4. public:
  5.     virtual bool dump(const std::string& name, const base::StringPiece& description) = 0;
  6. };
  8. // Options for MVariable::dump_exposed().
  9. struct DumpOptions {
  10.     // Contructed with default options.
  11.     DumpOptions();
  12.     // If this is true, string-type values will be quoted.
  13.     bool quote_string;
  14.     // The ? in wildcards. Wildcards in URL need to use another character
  15.     // because ? is reserved.
  16.     char question_mark; // 目前不支持
  17.     // Separator for white_wildcards and black_wildcards.
  18.     char wildcard_separator; // 目前不支持
  19.     // Name matched by these wildcards (or exact names) are kept.
  20.     std::string white_wildcards; // 目前不支持
  21.     // Name matched by these wildcards (or exact names) are skipped.
  22.     std::string black_wildcards; // 目前不支持
  23. };
  25. class MVariable {
  26.     ...
  27.     ...
  28.     // Find all exposed mvariables and send them to `dumper'.
  29.     // Use default options when `options' is NULL.
  30.     // Return number of dumped mvariables, -1 on error.
  31.     static size_t dump_exposed(Dumper* dumper, const DumpOptions* options);
  32. };

最常见的导出需求是通过HTTP接口查询和写入本地文件，多维度统计暂时不提供HTTP接口方式查询，后者已经在bvar中实现了，由用户选择开启，该功能由下面5个gflags控制，你的程序需要使用gflags。

名称默认值描述
mbvardumpfalseCreate a background thread dumping(shares the same thread as bvar_dump) all mbvar periodically, all bvar_dump* flags are not effective when this flag is off
mbvar_dump_filemonitor/mbvar.<app>.dataDump mbvar into this file
mbvar_dump_formatcommonDump mbvar write format
common：文本格式，Key和Value用冒号分割(和目前的单维度dump文件格式一致)

prometheus：文本格式，Key和Value用空格分开protobuf：二进制格式，暂时不支持
bvar_dump_interval10Seconds between consecutive dump
mbvar_dump_prefix<app>Every dumped name starts with this prefix

用户可在程序启动前加上对应的gflags。

当mbvar_dump=true并且mbvar_dump_file不为空时，程序会启动一个后台导出线程以bvar_dump_interval指定的间隔更新mbvar_dump_file，其中包含所有的多维统计项mbvar。

比如我们把所有的gflags修改为下表：

名称默认值描述
mbvardumptrueCreate a background thread dumping(shares the same thread as bvar_dump) all mbvar periodically, all bvar_dump* flags are not effective when this flag is off
mbvar_dump_filemonitor/mbvar.<app>.dataDump mbvar into this file
mbvar_dump_formatcommonDump mbvar write format
common：文本格式，Key和Value用冒号分割(和目前的单维度dump文件格式一致)

prometheus：文本格式，Key和Value用空格分开protobuf：二进制格式，暂时不支持
bvar_dump_interval10Seconds between consecutive dump
mbvar_dump_prefixmbvarEvery dumped name starts with this prefix

导出的本地文件为monitor/mbvar.<app>.data：

  1. mbvar_test_concurrent_write_and_read{idc=idc3,method=method6,status=status40} : 76896
  2. mbvar_test_concurrent_write_and_read{idc=idc5,method=method6,status=status36} : 147910
  3. mbvar_test_concurrent_write_and_read{idc=idc5,method=method12,status=status23} : 209270
  4. mbvar_test_concurrent_write_and_read{idc=idc3,method=method1,status=status6} : 116325
  5. mbvar_test_concurrent_write_and_read{idc=idc5,method=method10,status=status29} : 193536
  6. mbvar_test_concurrent_write_and_read{idc=idc5,method=method15,status=status6} : 294726
  7. mbvar_test_concurrent_write_and_read{idc=idc3,method=method2,status=status13} : 136676
  8. mbvar_test_concurrent_write_and_read{idc=idc2,method=method5,status=status49} : 43203
  9. mbvar_test_concurrent_write_and_read{idc=idc5,method=method10,status=status1} : 312499
  10. mbvar_test_concurrent_write_and_read{idc=idc1,method=method10,status=status35} : 35698

如果你的程序没有使用brpc，仍需要动态修改gflags（一般不需要），可以调用google::SetCommandLineOption()，如下所示：

  1. #include <gflags/gflags.h>
  2. ...
  3. if (google::SetCommandLineOption("mbvar_dump_format", "prometheus").empty()) {
  4.     LOG(ERROR) << "Fail to set mbvar_dump_format";
  5.     return -1;
  6. }
  7. LOG(INFO) << "Successfully set mbvar_dump_format to prometheus";

请勿直接设置 FLAGS_mbvar_dump_file / FLAGS_mbvar_dump_format / FLAGS_bvar_dump_prefix，如果有需求可以调用google::SetCommandLineOption()方法进行修改。

一方面这些gflag类型都是std::string，直接覆盖是线程不安全的；另一方面不会触发validator（检查正确性的回调），所以也不会启动后台导出线程。

count

统计相关函数

  1. class MVariable {
  2. public:
  3.     ...
  4.     // Get number of exposed mvariables
  5.     static size_t count_exposed();
  6. };

count_exposed

获取目前已经曝光的多维度统计项mbvar的个数，注意：这里是多维度统计项(多维度mbvar变量)，而不是维度数。

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_count("request_count", {"idc", "method", "status"});
  9. // 定义另一个全局多维度mbvar变量
  10. bvar::MultiDimension<bvar::Adder<int> > g_psmi_count("psmi_count", {"product", "system", "module", "interface"});
  12. size_t count_exposed() {
  13.     size_t mbvar_count_exposed = bvar::MVariable::count_exposed();
  14.     CHECK_EQ(2, mbvar_count_exposed);
  15.     return mbvar_count_exposed;
  16. }
  18. } // namespace bar
  19. } // namespace foo

使用说明

一般情况下用不到count_系列统计函数，如果有特殊需求，也不建议频繁调用。

list

  1. class MVariable {
  2. public:
  3.     ...
  4.     // Put names of all exposed mbvariable into `names'
  5.     static size_t list_exposed(std::vector<std::string>* names);
  6. };

list_exposed

获取所有曝光的多维度统计项mbvar名称

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_count("request_count", {"idc", "method", "status"});
  9. // 定义另一个全局多维度mbvar变量
  10. bvar::MultiDimension<bvar::Adder<int> > g_psmi_count("psmi_count", {"product", "system", "module", "interface"});
  12. size_t mbvar_list_exposed(std::vector<std::string>* names) {
  13.     if (!names) {
  14.         return -1;
  15.     }
  17.     // clear
  18.     names.clear();
  19.     bvar::MVariable::list_exposed(names);
  20.     // names：[ "request_count", "psmi_count" ]
  21.     CHECK_EQ(2, names->size());
  22.     return names->size();
  23. }
  25. } // namespace bar
  26. } // namespace foo

bvar::MultiDimension

多维度统计的实现，主要提供bvar的获取、列举等功能。

constructor

有三个构造函数：

  1. template <typename T>
  2. class MultiDimension : public MVariable {
  3. public:
  4.     // 不建议使用
  5.     explicit MultiDimension(const key_type& labels);
  7.     // 推荐使用
  8.     MultiDimension(const base::StringPiece& name,
  9.                    const key_type& labels);
  10.     // 推荐使用
  11.     MultiDimension(const base::StringPiece& prefix,
  12.                    const base::StringPiece& name,
  13.                    const key_type& labels);
  14.     ...
  15. };

explicit MultiDimension(const key_type& labels)

  • 不建议使用
  • 不会“曝光”多维度统计变量(mbvar)，即没有注册到任何全局结构* 中
  • 不会dump到本地文件，即使-bvar_dump=true、-mbvar_dump_file不为空
  • mbvar纯粹是一个更快的多维度计数器

MultiDimension(const base::StringPiece& name, const key_type& labels)

  • 推荐使用
  • 会曝光(调用MVariable::expose(name))，也会注册到全局结构中
  • -bvar_dump=true时，会启动一个后台导出线程以bvar_dump_interval指定的时间间隔更新mbvar_dump_file文件
  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_count("request_count", {"idc", "method", "status"});
  9. } // namespace bar
  10. } // namespace foo

MultiDimension(const base::StringPiece& prefix, const base::StringPiece& name, const key_type& labels)

  • 推荐使用
  • 会曝光(调用MVariable::expose_as(prefix, name))，也会注册到全局结构中
  • -bvar_dump=true时，会启动一个后台导出线程以bvar_dump_interval指定的时间间隔更新mbvar_dump_file文件
  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_count("foo_bar", "request_count", {"idc", "method", "status"});
  9. } // namespace bar
  10. } // namespace foo

stats

  1. template <typename T>
  2. class MultiDimension : public MVariable {
  3. public:
  4.     ...
  6.     // Get real bvar pointer object
  7.     // Return real bvar pointer(Not NULL) on success, NULL otherwise.
  8.     T* get_stats(const std::list<std::string>& labels_value);
  9. };

get_stats

根据指定label获取对应的单维度统计项bvar

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_count("request_count", {"idc", "method", "status"});
  9. int get_request_count(const std::list<std::string>& request_label) {
  10.     // 获取request_label对应的单维度bvar指针，比如：request_label = {"tc", "get", "200"}
  11.     bvar::Adder<int> *request_adder = g_request_count.get_stats(request_label);
  12.     // 判断指针非空
  13.     if (!request_adder) {
  14.         return -1;
  15.     }
  17.     // request_adder只能在g_request_count的生命周期内访问，否则行为未定义，可能会出core
  18.     *request_adder << 1;
  19.     return request_adder->get_value();
  20. }
  22. } // namespace bar
  23. } // namespace foo

内部实现逻辑

判断该label是否已经存在对应的单维度统计项bvar：

  • 存在
    • return bvar
  • 不存在
    • new bvar()
    • store(bvar)
    • return bvar

bvar的生命周期

label对应的单维度统计项bvar存储在多维度统计项(mbvar)中，当mbvar析构的时候会释放自身所有bvar，所以用户必须保证在mbvar的生命周期之内操作bvar，在mbvar生命周期外访问bvar的行为未定义，极有可能出core。

count

  1. class MVariable {
  2. public:
  3.     ...
  5.     // Get number of mvariable labels
  6.     size_t count_labels() const;
  7. };
  9. template <typename T>
  10. class MultiDimension : public MVariable {
  11. public:
  12.     ...
  14.     // Get number of stats
  15.     size_t count_stats();
  16. };

count_labels

获取多维度统计项的labels个数，用户在创建多维度(bvar::MultiDimension)统计项的时候，需要提供类型为std::list<std::string>的labels变量，我们提供了count_labels函数，返回labels的长度。

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_count("request_count", {"idc", "method", "status"});
  9. size_t count_labels() {
  10.     size_t mbvar_count_labels = g_request_count.count_labels();
  11.     CHECK_EQ(3, mbvar_count_labels);
  12.     return mbvar_count_labels;
  13. }
  14. } // namespace bar
  15. } // namespace foo

count_stats

获取多维度(bvar::MultiDimension)统计项的维度(stats)数

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_count("request_count", {"idc", "method", "status"});
  9. size_t count_stats() {
  10.     // 获取request1对应的单维度mbvar指针，假设request1_labels = {"tc", "get", "200"}
  11.     bvar::Adder<int> *request1_adder = g_request_count.get_stats(request1_labels);
  12.     // 判断指针非空
  13.     if (!request1_adder) {
  14.         return -1;
  15.     }
  16.     // request1_adder只能在g_request_count生命周期内访问，否则行为未定义，可能会出core
  17.     *request1_adder << 1;
  19.     // 获取request2对应的单维度mbvar指针，假设request2_labels = {"nj", "get", "200"}
  20.     bvar::Adder<int> *request2_adder = g_request_count.get_stats(request2_labels);
  21.     // 判断指针非空
  22.     if (!request2_adder) {
  23.         return -1;
  24.     }
  25.     // request2_adder只能在g_request_count生命周期内访问，否则行为未定义，可能会出core
  26.     *request2_adder << 1;
  29.     size_t mbvar_count_stats = g_request_count.count_stats();
  30.     CHECK_EQ(2, mbvar_count_stats);
  31.     return mbvar_count_stats;
  32. }
  33. } // namespace bar
  34. } // namespace foo

list

  1. template <typename T>
  2. class MultiDimension : public MVariable {
  3. public:
  4.     ...
  5.     // Put all stats labels into `names'
  6.     void list_stats(std::vector<std::list<std::string> >* names);
  7. };

list_stats

获取一个多维度统计项下所有labels组合列表

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_count("request_count", {"idc", "method", "status"});
  9. size_t list_stats(std::vector<std::list<std::string> > *stats_names) {
  10.     if (!stats_names) {
  11.         return -1;
  12.     }
  14.     // clear
  15.     stats_names.clear();
  17.     // 获取request1对应的单维度mbvar指针，假设request1_labels = {"tc", "get", "200"}
  18.     bvar::Adder<int> *request1_adder = g_request_count.get_stats(request1_labels);
  19.     // 判断指针非空
  20.     if (!request1_adder) {
  21.         return -1;
  22.     }
  24.     // 获取request2对应的单维度mbvar指针，假设request2_labels = {"nj", "get", "200"}
  25.     bvar::Adder<int> *request2_adder = g_request_count.get_stats(request2_labels);
  26.     // 判断指针非空
  27.     if (!request2_adder) {
  28.         return -1;
  29.     }
  31.     g_request_count.list_stats(stats_names);
  32.     // labels_names：
  33.     // [
  34.     //      {"tc", "get", "200"},
  35.     //      {"nj", "get", "200"}
  36.     // ]
  38.     CHECK_EQ(2, stats_names.size());
  39.     return stats_names.size();
  40. }
  42. } // namespace bar
  43. } // namespace foo

使用说明

一般情况下用户不需要获取labels组合列表，如果有特殊需求，也不建议频繁调用，否则可能影响get_stats的写入性能。

template

bvar::Adder

顾名思义，用于累加

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Adder<int> > g_request_cost("request_count", {"idc", "method", "status"});
  9. int request_cost_total(const std::list<std::string>& request_labels) {
  10.     // 获取request对应的单维度mbvar指针，假设request_labels = {"tc", "get", "200"}
  11.     bvar::Adder<int>* cost_add = g_request_cost.get_stats(request_labels);
  12.     // 判断指针非空
  13.     if (!cost_add) {
  14.         return -1;
  15.     }
  16.     // cost_add只能在g_request_cost生命周期内访问，否则行为未定义，可能会出core
  17.     *cost_add << 1 << 2 << 3 << 4;
  18.     CHECK_EQ(10, cost_add->get_value());
  19.     return cost_add->get_value();
  20. }
  22. } // namespace bar
  23. } // namespace foo

bvar::Maxer

用于取最大值，运算符为std::max

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Maxer<int> > g_request_cost("request_cost", {"idc", "method", "status"});
  9. int request_cost_max(const std::list<std::string>& request_labels) {
  10.     // 获取request对应的单维度mbvar指针，假设request_labels = {"tc", "get", "200"}
  11.     bvar::Maxer<int>* cost_max = g_request_cost.get_stats(request_labels);
  12.     // 判断指针非空
  13.     if (!cost_max) {
  14.         return -1;
  15.     }
  17.     // cost_max只能在g_request_cost生命周期内访问，否则行为未定义，可能会出core
  18.     *cost_max << 1 << 2 << 3 << 4;
  19.     CHECK_EQ(4, cost_max->get_value());
  20.     return cost_max->get_value();
  21. }
  23. } // namespace bar
  24. } // namespace foo

bvar::Miner

用于取最小值，运算符为std::min

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Miner<int> > g_request_cost("request_cost", {"idc", "method", "status"});
  9. int request_cost_min(const std::list<std::string>& request_labels) {
  10.     // 获取request对应的单维度mbvar指针，假设request_labels = {"tc", "get", "200"}
  11.     bvar::Miner<int>* cost_min = g_request_cost.get_stats(request_labels);
  12.     // 判断指针非空
  13.     if (!cost_min) {
  14.         return -1;
  15.     }
  17.     // cost_min只能在g_request_cost生命周期内访问，否则行为未定义，可能会出core
  18.     *cost_min << 1 << 2 << 3 << 4;
  19.     CHECK_EQ(1, cost_min->get_value());
  20.     return cost_min->get_value();
  21. }
  23. } // namespace bar
  24. } // namespace foo

bvar::IntRecorder

用于计算平均值。

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::IntRecorder> g_request_cost("request_cost", {"idc", "method", "status"});
  9. int request_cost_avg(const std::list<std::string>& request_labels) {
  10.     // 获取request对应的单维度mbvar指针，假设request_labels = {"tc", "get", "200"}
  11.     bvar::IntRecorder* cost_avg = g_request_cost.get_stats(request_labels);
  12.     // 判断指针非空
  13.     if (!cost_avg) {
  14.         return -1;
  15.     }
  17.     // cost_avg只能在g_request_cost生命周期内访问，否则行为未定义，可能会出core
  18.     *cost_avg << 1 << 3 << 5;
  19.     CHECK_EQ(3, cost_avg->get_value());
  20.     return cost_avg->get_value();
  21. }
  23. } // namespace bar
  24. } // namespace foo

bvar::LatencyRecorder

专用于计算latency和qps的计数器。只需填入latency数据，就能获取latency / max_latency / qps / count，统计窗口是bvar_dump_interval。

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::LatencyRecorder> g_request_cost("request_cost", {"idc", "method", "status"});
  9. void request_cost_latency(const std::list<std::string>& request_labels) {
  10.     // 获取request对应的单维度mbvar指针，假设request_labels = {"tc", "get", "200"}
  11.     bvar::LatencyRecorder* cost_latency = g_request_cost.get_stats(request_labels);
  12.     // 判断指针非空
  13.     if (!cost_latency) {
  14.         return -1;
  15.     }
  17.     // cost_latency只能在g_request_cost生命周期内访问，否则行为未定义，可能会出core
  18.     *cost_latency << 1 << 2 << 3 << 4 << 5 << 6 << 7;
  20.     // 获取latency
  21.     int64_t request_cost_latency = cost_latency->latency();
  22.     // 获取max_latency
  23.     int64_t request_cost_max_latency = cost_latency->max_latency();
  24.     // 获取qps
  25.     int64_t request_cost_qps = cost_latency->qps();
  26.     // 获取count
  27.     int64_t request_cost_count = cost_latency->count();
  28. }
  30. } // namespace bar
  31. } // namespace foo

bvar::Status

记录和显示一个值，拥有额外的set_value函数。

  1. #include <bvar/bvar.h>
  2. #include <bvar/multi_dimension.h>
  4. namespace foo {
  5. namespace bar {
  6. // 定义一个全局的多维度mbvar变量
  7. bvar::MultiDimension<bvar::Status<int> > g_request_cost("request_cost", {"idc", "method", "status"});
  9. void request_cost(const std::list<std::string>& request_labels) {
  10.     // 获取request对应的单维度mbvar指针，假设request_labels = {"tc", "get", "200"}
  11.     bvar::Status<int>* cost_status = g_request_cost.get_stats(request_labels);
  12.     // 判断指针非空
  13.     if (!cost_status) {
  14.         return -1;
  15.     }
  17.     // cost_status只能在g_request_cost生命周期内访问，否则行为未定义，可能会出core
  18.     cost_status->set_value(5);
  19.     CHECK_EQ(5, cost_status->get_value());
  20. }
  22. } // namespace bar
  23. } // namespace foo

修改于 2023年2月13日: add the new committer Zhaogeng Li (#133) (ade03ff)