#include <string_view>
#include <pthread.h>
#include <cstddef>
#include <memory>
#include <iostream>
#include <set>
#include <string>
#include <array>
#include <vector>
#include <gflags/gflags.h>
#include <gtest/gtest.h>
#include "butil/time.h"
#include "butil/logging.h"
#include "butil/macros.h"
#include "butil/memory/scope_guard.h"
#include "butil/strings/string_number_conversions.h"
#include "bvar/bvar.h"
#include "bvar/multi_dimension.h"
namespace bvar {
DECLARE_int32(bvar_max_dump_multi_dimension_metric_number);
}
static const std::list<std::string> labels = {"idc", "method", "status"};
class MVariableTest : public testing::Test {
protected:
void SetUp() {}
void TearDown() {
}
};
namespace foo {
namespace bar {
class Apple {};
class BaNaNa {};
class Car_Rot {};
class RPCTest {};
class HELLO {};
}
}
TEST_F(MVariableTest, expose) {
std::vector<std::string> list_exposed_vars;
std::list<std::string> labels_value1 {"bj", "get", "200"};
bvar::MultiDimension<bvar::Adder<int> > my_madder1(labels);
ASSERT_EQ(0UL, bvar::MVariableBase::count_exposed());
my_madder1.expose("request_count_madder");
ASSERT_EQ(1UL, bvar::MVariableBase::count_exposed());
bvar::Adder<int>* my_adder1 = my_madder1.get_stats(labels_value1);
ASSERT_TRUE(my_adder1);
ASSERT_STREQ("request_count_madder", my_madder1.name().c_str());
ASSERT_EQ(0, my_madder1.expose("request_count_madder_another"));
ASSERT_STREQ("request_count_madder_another", my_madder1.name().c_str());
ASSERT_EQ(0, my_madder1.expose("request-count::madder"));
ASSERT_STREQ("request_count_madder", my_madder1.name().c_str());
ASSERT_EQ(0, my_madder1.expose("request.count-madder::BaNaNa"));
ASSERT_STREQ("request_count_madder_ba_na_na", my_madder1.name().c_str());
ASSERT_EQ(0, my_madder1.expose_as("foo::bar::Apple", "request"));
ASSERT_STREQ("foo_bar_apple_request", my_madder1.name().c_str());
ASSERT_EQ(0, my_madder1.expose_as("foo.bar::BaNaNa", "request"));
ASSERT_STREQ("foo_bar_ba_na_na_request", my_madder1.name().c_str());
ASSERT_EQ(0, my_madder1.expose_as("foo::bar.Car_Rot", "request"));
ASSERT_STREQ("foo_bar_car_rot_request", my_madder1.name().c_str());
ASSERT_EQ(0, my_madder1.expose_as("foo-bar-RPCTest", "request"));
ASSERT_STREQ("foo_bar_rpctest_request", my_madder1.name().c_str());
ASSERT_EQ(0, my_madder1.expose_as("foo-bar-HELLO", "request"));
ASSERT_STREQ("foo_bar_hello_request", my_madder1.name().c_str());
my_madder1.expose("request_count_madder");
ASSERT_STREQ("request_count_madder", my_madder1.name().c_str());
list_exposed_vars.push_back("request_count_madder");
ASSERT_EQ(1UL, my_madder1.count_stats());
ASSERT_EQ(1UL, bvar::MVariableBase::count_exposed());
std::list<std::string> labels2 {"user", "url", "cost"};
bvar::MultiDimension<bvar::Adder<int> > my_madder2("client_url", labels2);
ASSERT_EQ(2UL, bvar::MVariableBase::count_exposed());
list_exposed_vars.push_back("client_url");
std::list<std::string> labels3 {"product", "system", "module"};
bvar::MultiDimension<bvar::Adder<int> > my_madder3("request_from", labels3);
list_exposed_vars.push_back("request_from");
ASSERT_EQ(3UL, bvar::MVariableBase::count_exposed());
std::vector<std::string> exposed_vars;
bvar::MVariableBase::list_exposed(&exposed_vars);
ASSERT_EQ(3, exposed_vars.size());
my_madder3.hide();
ASSERT_EQ(2UL, bvar::MVariableBase::count_exposed());
list_exposed_vars.pop_back();
exposed_vars.clear();
bvar::MVariableBase::list_exposed(&exposed_vars);
ASSERT_EQ(2, exposed_vars.size());
}
TEST_F(MVariableTest, hide_all_clears_name) {
std::list<std::string> one_label = {"method"};
bvar::MultiDimension<bvar::Histogram> multi(
one_label, bvar::Histogram::BucketSchema({1}));
ASSERT_EQ(0, multi.expose("hide_all_clears_name"));
bvar::MVariableBase::hide_all();
ASSERT_EQ(0UL, bvar::MVariableBase::count_exposed());
ASSERT_TRUE(multi.name().empty());
ASSERT_EQ(0, multi.expose("hide_all_clears_name"));
}
TEST_F(MVariableTest, dump) {
std::string old_bvar_dump_interval;
std::string old_mbvar_dump;
std::string old_mbvar_dump_prefix;
std::string old_mbvar_dump_format;
GFLAGS_NAMESPACE::GetCommandLineOption("bvar_dump_interval", &old_bvar_dump_interval);
GFLAGS_NAMESPACE::GetCommandLineOption("mbvar_dump", &old_mbvar_dump);
GFLAGS_NAMESPACE::GetCommandLineOption("mbvar_dump_prefix", &old_mbvar_dump_prefix);
GFLAGS_NAMESPACE::GetCommandLineOption("mbvar_dump_format", &old_mbvar_dump_format);
GFLAGS_NAMESPACE::SetCommandLineOption("bvar_dump_interval", "1");
GFLAGS_NAMESPACE::SetCommandLineOption("mbvar_dump", "true");
GFLAGS_NAMESPACE::SetCommandLineOption("mbvar_dump_prefix", "my_mdump_prefix");
GFLAGS_NAMESPACE::SetCommandLineOption("mbvar_dump_format", "common");
bvar::MultiDimension<bvar::Adder<int> > my_madder("dump_adder", labels);
std::list<std::string> labels_value1 {"gz", "post", "200"};
bvar::Adder<int>* adder1 = my_madder.get_stats(labels_value1);
ASSERT_TRUE(adder1);
*adder1 << 1 << 3 << 5;
std::list<std::string> labels_value2 {"tc", "get", "200"};
bvar::Adder<int>* adder2 = my_madder.get_stats(labels_value2);
ASSERT_TRUE(adder2);
*adder2 << 2 << 4 << 6;
std::list<std::string> labels_value3 {"jx", "post", "500"};
bvar::Adder<int>* adder3 = my_madder.get_stats(labels_value3);
ASSERT_TRUE(adder3);
*adder3 << 3 << 6 << 9;
bvar::MultiDimension<bvar::Maxer<int> > my_mmaxer("dump_maxer", labels);
bvar::Maxer<int>* maxer1 = my_mmaxer.get_stats(labels_value1);
ASSERT_TRUE(maxer1);
*maxer1 << 3 << 1 << 5;
bvar::Maxer<int>* maxer2 = my_mmaxer.get_stats(labels_value2);
ASSERT_TRUE(maxer2);
*maxer2 << 2 << 6 << 4;
bvar::Maxer<int>* maxer3 = my_mmaxer.get_stats(labels_value3);
ASSERT_TRUE(maxer3);
*maxer3 << 9 << 6 << 3;
bvar::MultiDimension<bvar::Miner<int> > my_mminer("dump_miner", labels);
bvar::Miner<int>* miner1 = my_mminer.get_stats(labels_value1);
ASSERT_TRUE(miner1);
*miner1 << 3 << 1 << 5;
bvar::Miner<int>* miner2 = my_mminer.get_stats(labels_value2);
ASSERT_TRUE(miner2);
*miner2 << 2 << 6 << 4;
bvar::Miner<int>* miner3 = my_mminer.get_stats(labels_value3);
ASSERT_TRUE(miner3);
*miner3 << 9 << 6 << 3;
bvar::MultiDimension<bvar::LatencyRecorder> my_mlatencyrecorder("dump_latencyrecorder", labels);
bvar::LatencyRecorder* my_latencyrecorder1 = my_mlatencyrecorder.get_stats(labels_value1);
ASSERT_TRUE(my_latencyrecorder1);
*my_latencyrecorder1 << 1 << 3 << 5;
*my_latencyrecorder1 << 2 << 4 << 6;
*my_latencyrecorder1 << 3 << 6 << 9;
sleep(2);
GFLAGS_NAMESPACE::SetCommandLineOption("bvar_dump_interval", old_bvar_dump_interval.c_str());
GFLAGS_NAMESPACE::SetCommandLineOption("mbvar_dump", old_mbvar_dump.c_str());
GFLAGS_NAMESPACE::SetCommandLineOption("mbvar_dump_prefix", old_mbvar_dump_prefix.c_str());
GFLAGS_NAMESPACE::SetCommandLineOption("mbvar_dump_format", old_mbvar_dump_format.c_str());
}
TEST_F(MVariableTest, test_describe_exposed) {
std::string bvar_name("request_count_describe");
bvar::MultiDimension<bvar::Adder<int> > my_madder1(bvar_name, labels);
std::string describe_str = bvar::MVariableBase::describe_exposed(bvar_name);
std::ostringstream describe_oss;
ASSERT_EQ(0, bvar::MVariableBase::describe_exposed(bvar_name, describe_oss));
ASSERT_STREQ(describe_str.c_str(), describe_oss.str().c_str());
}
class RegionedGauge {
public:
explicit RegionedGauge(const std::string& region = "north")
: _region(region) {}
void set(int64_t value) { _value = value; }
static std::vector<bvar::MetricFamily> list_metric_families() {
return {{"", "gauge", {"region"}}};
}
bool dump_samples(bvar::Dumper* dumper, size_t ,
const std::string& name,
butil::StringPiece labels) const {
std::string key(name);
key.push_back('{');
if (!labels.empty()) {
key.append(labels.data(), labels.size());
key.push_back(',');
}
key.append("region=\"");
key.append(_region);
key.append("\"}");
return dumper->dump_mvar(key, butil::Int64ToString(_value));
}
private:
std::string _region;
int64_t _value{0};
};
TEST_F(MVariableTest, multi_dimension_rejects_reserved_labels) {
size_t nexposed = bvar::MVariableBase::count_exposed();
ASSERT_TRUE(bvar::detail::IsCompositeMetric<RegionedGauge>::value);
bvar::MultiDimension<bvar::Histogram> mhist(
"hist_reserved_label_test", {"method", "le"},
bvar::Histogram::BucketSchema({10, 20}));
ASSERT_TRUE(mhist.name().empty());
ASSERT_NE(nullptr, mhist.get_stats({"echo", "10"}));
ASSERT_EQ(-1, mhist.expose("hist_reserved_label_test"));
ASSERT_TRUE(mhist.name().empty());
bvar::MVariableBase* mvariable_base = &mhist;
ASSERT_EQ(-1, mvariable_base->expose("hist_reserved_label_base_test"));
ASSERT_TRUE(mhist.name().empty());
bvar::MVariable<std::list<std::string> >* typed_base = &mhist;
ASSERT_EQ(-1, typed_base->expose_as("hist", "reserved_label_typed_base_test"));
ASSERT_TRUE(mhist.name().empty());
bvar::MultiDimension<bvar::LatencyRecorder> mlr(
"latency_reserved_label_test", {"method", "quantile"});
ASSERT_TRUE(mlr.name().empty());
ASSERT_NE(nullptr, mlr.get_stats({"echo", "0.99"}));
ASSERT_EQ(-1, mlr.expose("latency_reserved_label_test"));
bvar::MultiDimension<RegionedGauge> conflict(
"custom_reserved_label_test", {"idc", "region"});
ASSERT_TRUE(conflict.name().empty());
ASSERT_NE(nullptr, conflict.get_stats({"bj", "north"}));
ASSERT_EQ(-1, conflict.expose("custom_reserved_label_test"));
ASSERT_TRUE(conflict.name().empty());
bvar::MultiDimension<bvar::Histogram> valid_histogram(
{"quantile"}, bvar::Histogram::BucketSchema({10, 20}));
ASSERT_NE(nullptr, valid_histogram.get_stats({"0.99"}));
bvar::MultiDimension<bvar::LatencyRecorder> valid_recorder({"le"});
ASSERT_NE(nullptr, valid_recorder.get_stats({"10"}));
bvar::MultiDimension<RegionedGauge> ok(
"custom_reserved_label_ok", {"idc", "method"});
ASSERT_NE(nullptr, ok.get_stats({"bj", "get"}));
ASSERT_STREQ("custom_reserved_label_ok", ok.name().c_str());
ASSERT_TRUE(ok.hide());
ASSERT_EQ(nexposed, bvar::MVariableBase::count_exposed());
}
class RecordingDumper : public bvar::Dumper {
public:
bool dump(const std::string& name,
const butil::StringPiece& desc) override {
lines.push_back("dump_" + name + " " + desc.as_string());
return true;
}
bool dump_mvar(const std::string& name,
const butil::StringPiece& desc) override {
lines.push_back("mvar_" + name + " " + desc.as_string());
return true;
}
bool dump_comment(const std::string& name,
const std::string& type) override {
lines.push_back("comment " + name + " " + type);
return true;
}
size_t count_metrics() const {
size_t n = 0;
for (auto& line : lines) {
if (line.compare(0, 5, "mvar_") == 0 ||
line.compare(0, 5, "dump_") == 0) {
++n;
}
}
return n;
}
std::vector<std::string> lines;
};
TEST_F(MVariableTest, dump_exposed_honours_the_metric_cap) {
bvar::MultiDimension<bvar::Histogram> mhist(
"hist_mvar_cap_test", {"method"},
bvar::Histogram::BucketSchema({10, 20}));
for (int i = 0; i < 20; ++i) {
*mhist.get_stats({"m" + butil::IntToString(i)}) << 5;
}
int32_t saved = bvar::FLAGS_bvar_max_dump_multi_dimension_metric_number;
bvar::FLAGS_bvar_max_dump_multi_dimension_metric_number = 7;
BUTIL_SCOPE_EXIT {
bvar::FLAGS_bvar_max_dump_multi_dimension_metric_number = saved;
};
RecordingDumper d;
bvar::DumpOptions opt;
ASSERT_EQ(7, bvar::MVariableBase::dump_exposed(&d, &opt));
ASSERT_EQ(7u, d.count_metrics());
}
class TaggedCounter {
public:
explicit TaggedCounter(const std::string& tag) : _tag(tag) {}
void describe(std::ostream& os, bool) const { os << _tag; }
const std::string& tag() const { return _tag; }
private:
std::string _tag;
};
TEST_F(MVariableTest, value_args_are_copied) {
std::string tag(64, 'a');
bvar::MultiDimension<TaggedCounter> md({"method"}, tag);
tag.assign(64, 'b');
TaggedCounter* counter = md.get_stats({"echo"});
ASSERT_NE(nullptr, counter);
ASSERT_EQ(std::string(64, 'a'), counter->tag());
}
TEST_F(MVariableTest, value_naming_itself_is_reported) {
std::list<std::string> one_label = {"method"};
bvar::MultiDimension<bvar::Adder<int> > md(one_label, "misplaced_mvar_name");
ASSERT_TRUE(md.name().empty());
logging::StringSink log_str;
logging::LogSink* old_sink = logging::SetLogSink(&log_str);
bvar::Adder<int>* adder = md.get_stats({"echo"});
ASSERT_EQ(&log_str, logging::SetLogSink(old_sink));
ASSERT_NE(nullptr, adder);
ASSERT_TRUE(adder->name().empty());
ASSERT_NE(std::string::npos, log_str.find("misplaced_mvar_name"))
<< "log: " << log_str;
}