mirror of
https://github.com/zeek/zeek.git
synced 2025-10-12 03:28:19 +00:00
Add gauge metric types
This commit is contained in:
Dominik Charousset
parent
617e4137c6
commit
59d114005e
7 changed files with 866 additions and 2 deletions
|
|
@ -22,6 +22,14 @@ using NativeDblCounter = ct::dbl_counter;
|
|||
|
||||
using NativeDblCounterFamily = ct::metric_family_impl<NativeDblCounter>;
|
||||
|
||||
using NativeIntGauge = ct::int_gauge;
|
||||
|
||||
using NativeIntGaugeFamily = ct::metric_family_impl<NativeIntGauge>;
|
||||
|
||||
using NativeDblGauge = ct::dbl_gauge;
|
||||
|
||||
using NativeDblGaugeFamily = ct::metric_family_impl<NativeDblGauge>;
|
||||
|
||||
auto& deref(Manager::Impl* ptr)
|
||||
{
|
||||
return *reinterpret_cast<NativeManager*>(ptr);
|
||||
|
|
@ -42,6 +50,16 @@ auto opaque(NativeDblCounterFamily* ptr)
|
|||
return reinterpret_cast<DblCounterFamily::Impl*>(ptr);
|
||||
}
|
||||
|
||||
auto opaque(NativeIntGaugeFamily* ptr)
|
||||
{
|
||||
return reinterpret_cast<IntGaugeFamily::Impl*>(ptr);
|
||||
}
|
||||
|
||||
auto opaque(NativeDblGaugeFamily* ptr)
|
||||
{
|
||||
return reinterpret_cast<DblGaugeFamily::Impl*>(ptr);
|
||||
}
|
||||
|
||||
template <class F>
|
||||
auto withNative(Span<const std::string_view> xs, F continuation)
|
||||
{
|
||||
|
|
@ -91,13 +109,56 @@ DblCounterFamily Manager::dblCounterFam(std::string_view prefix,
|
|||
});
|
||||
}
|
||||
|
||||
IntGaugeFamily Manager::intGaugeFam(std::string_view prefix,
|
||||
std::string_view name,
|
||||
Span<const std::string_view> labels,
|
||||
std::string_view helptext,
|
||||
std::string_view unit, bool isSum)
|
||||
{
|
||||
return withNative(labels, [&, this](auto xs)
|
||||
{
|
||||
auto ptr = deref(pimpl).gauge_family(prefix, name, xs,
|
||||
helptext, unit, isSum);
|
||||
return IntGaugeFamily{opaque(ptr)};
|
||||
});
|
||||
}
|
||||
|
||||
DblGaugeFamily Manager::dblGaugeFam(std::string_view prefix,
|
||||
std::string_view name,
|
||||
Span<const std::string_view> labels,
|
||||
std::string_view helptext,
|
||||
std::string_view unit, bool isSum)
|
||||
{
|
||||
return withNative(labels, [&, this](auto xs)
|
||||
{
|
||||
auto ptr = deref(pimpl).gauge_family<double>(prefix, name, xs,
|
||||
helptext, unit, isSum);
|
||||
return DblGaugeFamily{opaque(ptr)};
|
||||
});
|
||||
}
|
||||
|
||||
} // namespace zeek::telemetry
|
||||
|
||||
// -- unit tests ---------------------------------------------------------------
|
||||
|
||||
using namespace std::literals;
|
||||
using namespace zeek::telemetry;
|
||||
|
||||
SCENARIO("telemetry managers provide access to counters")
|
||||
namespace {
|
||||
|
||||
template <class T>
|
||||
auto toVector(zeek::Span<T> xs)
|
||||
{
|
||||
std::vector<std::remove_const_t<T>> result;
|
||||
for (auto&& x : xs)
|
||||
result.emplace_back(x);
|
||||
return result;
|
||||
}
|
||||
|
||||
|
||||
} // namespace
|
||||
|
||||
SCENARIO("telemetry managers provide access to counter singletons")
|
||||
{
|
||||
GIVEN("a telemetry manager")
|
||||
{
|
||||
|
|
@ -157,3 +218,190 @@ SCENARIO("telemetry managers provide access to counters")
|
|||
}
|
||||
}
|
||||
}
|
||||
|
||||
SCENARIO("telemetry managers provide access to counter families")
|
||||
{
|
||||
GIVEN("a telemetry manager")
|
||||
{
|
||||
NativeManager nativeMgr;
|
||||
Manager mgr{opaque(&nativeMgr)};
|
||||
WHEN("retrieving an IntCounter family")
|
||||
{
|
||||
auto family = mgr.counterFamily("zeek", "requests", {"method"}, "test", "1", true);
|
||||
THEN("the family object stores the parameters")
|
||||
{
|
||||
CHECK_EQ(family.prefix(), "zeek"sv);
|
||||
CHECK_EQ(family.name(), "requests"sv);
|
||||
CHECK_EQ(toVector(family.labelNames()), std::vector{"method"s});
|
||||
CHECK_EQ(family.helptext(), "test"sv);
|
||||
CHECK_EQ(family.unit(), "1"sv);
|
||||
CHECK_EQ(family.isSum(), true);
|
||||
}
|
||||
AND_THEN("getOrAdd returns the same metric for the same labels")
|
||||
{
|
||||
auto first = family.getOrAdd({{"method", "get"}});
|
||||
auto second = family.getOrAdd({{"method", "get"}});
|
||||
CHECK_EQ(first, second);
|
||||
}
|
||||
AND_THEN("getOrAdd returns different metric for the disjoint labels")
|
||||
{
|
||||
auto first = family.getOrAdd({{"method", "get"}});
|
||||
auto second = family.getOrAdd({{"method", "put"}});
|
||||
CHECK_NE(first, second);
|
||||
}
|
||||
}
|
||||
WHEN("retrieving a DblCounter family")
|
||||
{
|
||||
auto family = mgr.counterFamily<double>("zeek", "runtime", {"query"}, "test", "seconds", true);
|
||||
THEN("the family object stores the parameters")
|
||||
{
|
||||
CHECK_EQ(family.prefix(), "zeek"sv);
|
||||
CHECK_EQ(family.name(), "runtime"sv);
|
||||
CHECK_EQ(toVector(family.labelNames()), std::vector{"query"s});
|
||||
CHECK_EQ(family.helptext(), "test"sv);
|
||||
CHECK_EQ(family.unit(), "seconds"sv);
|
||||
CHECK_EQ(family.isSum(), true);
|
||||
}
|
||||
AND_THEN("getOrAdd returns the same metric for the same labels")
|
||||
{
|
||||
auto first = family.getOrAdd({{"query", "foo"}});
|
||||
auto second = family.getOrAdd({{"query", "foo"}});
|
||||
CHECK_EQ(first, second);
|
||||
}
|
||||
AND_THEN("getOrAdd returns different metric for the disjoint labels")
|
||||
{
|
||||
auto first = family.getOrAdd({{"query", "foo"}});
|
||||
auto second = family.getOrAdd({{"query", "bar"}});
|
||||
CHECK_NE(first, second);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
SCENARIO("telemetry managers provide access to gauge singletons")
|
||||
{
|
||||
GIVEN("a telemetry manager")
|
||||
{
|
||||
NativeManager nativeMgr;
|
||||
Manager mgr{opaque(&nativeMgr)};
|
||||
WHEN("retrieving an IntGauge singleton")
|
||||
{
|
||||
auto first = mgr.gaugeSingleton("zeek", "int-gauge", "test");
|
||||
THEN("its initial value is zero")
|
||||
{
|
||||
CHECK_EQ(first.value(), 0);
|
||||
}
|
||||
AND_THEN("calling inc(), dec(), operator++ or operator-- changes the value")
|
||||
{
|
||||
first.inc();
|
||||
CHECK_EQ(first.value(), 1);
|
||||
first.inc(2);
|
||||
CHECK_EQ(first.value(), 3);
|
||||
first.dec();
|
||||
CHECK_EQ(first.value(), 2);
|
||||
CHECK_EQ(++first, 3);
|
||||
CHECK_EQ(first.value(), 3);
|
||||
CHECK_EQ(--first, 2);
|
||||
CHECK_EQ(first.value(), 2);
|
||||
}
|
||||
AND_THEN("calling gaugeSingleton again for the same name returns the same handle")
|
||||
{
|
||||
auto second = mgr.gaugeSingleton("zeek", "int-gauge", "test");
|
||||
CHECK_EQ(first, second);
|
||||
}
|
||||
AND_THEN("calling gaugeSingleton for a different name returns another handle")
|
||||
{
|
||||
auto third = mgr.gaugeSingleton("zeek", "int-gauge-2", "test");
|
||||
CHECK_NE(first, third);
|
||||
}
|
||||
}
|
||||
WHEN("retrieving a DblGauge singleton")
|
||||
{
|
||||
auto first = mgr.gaugeSingleton<double>("zeek", "dbl-gauge", "test");
|
||||
THEN("its initial value is zero")
|
||||
{
|
||||
CHECK_EQ(first.value(), 0.0);
|
||||
}
|
||||
AND_THEN("calling inc() or dec() changes the value")
|
||||
{
|
||||
first.inc();
|
||||
CHECK_EQ(first.value(), 1.0);
|
||||
first.inc(3.0);
|
||||
CHECK_EQ(first.value(), 4.0);
|
||||
first.dec(2.0);
|
||||
CHECK_EQ(first.value(), 2.0);
|
||||
first.dec();
|
||||
CHECK_EQ(first.value(), 1.0);
|
||||
}
|
||||
AND_THEN("calling gaugeSingleton again for the same name returns the same handle")
|
||||
{
|
||||
auto second = mgr.gaugeSingleton<double>("zeek", "dbl-gauge", "test");
|
||||
CHECK_EQ(first, second);
|
||||
}
|
||||
AND_THEN("calling gaugeSingleton for a different name returns another handle")
|
||||
{
|
||||
auto third = mgr.gaugeSingleton<double>("zeek", "dbl-gauge-2", "test");
|
||||
CHECK_NE(first, third);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
SCENARIO("telemetry managers provide access to gauge families")
|
||||
{
|
||||
GIVEN("a telemetry manager")
|
||||
{
|
||||
NativeManager nativeMgr;
|
||||
Manager mgr{opaque(&nativeMgr)};
|
||||
WHEN("retrieving an IntGauge family")
|
||||
{
|
||||
auto family = mgr.gaugeFamily("zeek", "open-connections", {"protocol"}, "test");
|
||||
THEN("the family object stores the parameters")
|
||||
{
|
||||
CHECK_EQ(family.prefix(), "zeek"sv);
|
||||
CHECK_EQ(family.name(), "open-connections"sv);
|
||||
CHECK_EQ(toVector(family.labelNames()), std::vector{"protocol"s});
|
||||
CHECK_EQ(family.helptext(), "test"sv);
|
||||
CHECK_EQ(family.unit(), "1"sv);
|
||||
CHECK_EQ(family.isSum(), false);
|
||||
}
|
||||
AND_THEN("getOrAdd returns the same metric for the same labels")
|
||||
{
|
||||
auto first = family.getOrAdd({{"protocol", "tcp"}});
|
||||
auto second = family.getOrAdd({{"protocol", "tcp"}});
|
||||
CHECK_EQ(first, second);
|
||||
}
|
||||
AND_THEN("getOrAdd returns different metric for the disjoint labels")
|
||||
{
|
||||
auto first = family.getOrAdd({{"protocol", "tcp"}});
|
||||
auto second = family.getOrAdd({{"protocol", "quic"}});
|
||||
CHECK_NE(first, second);
|
||||
}
|
||||
}
|
||||
WHEN("retrieving a DblGauge family")
|
||||
{
|
||||
auto family = mgr.gaugeFamily<double>("zeek", "water-level", {"river"}, "test", "meters");
|
||||
THEN("the family object stores the parameters")
|
||||
{
|
||||
CHECK_EQ(family.prefix(), "zeek"sv);
|
||||
CHECK_EQ(family.name(), "water-level"sv);
|
||||
CHECK_EQ(toVector(family.labelNames()), std::vector{"river"s});
|
||||
CHECK_EQ(family.helptext(), "test"sv);
|
||||
CHECK_EQ(family.unit(), "meters"sv);
|
||||
CHECK_EQ(family.isSum(), false);
|
||||
}
|
||||
AND_THEN("getOrAdd returns the same metric for the same labels")
|
||||
{
|
||||
auto first = family.getOrAdd({{"river", "Sacramento"}});
|
||||
auto second = family.getOrAdd({{"river", "Sacramento"}});
|
||||
CHECK_EQ(first, second);
|
||||
}
|
||||
AND_THEN("getOrAdd returns different metric for the disjoint labels")
|
||||
{
|
||||
auto first = family.getOrAdd({{"query", "Sacramento"}});
|
||||
auto second = family.getOrAdd({{"query", "San Joaquin"}});
|
||||
CHECK_NE(first, second);
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue