github_mirrors/openappsec
3
0
Fork 1
mirror of https://github.com/openappsec/openappsec.git synced 2025-09-29 19:24:26 +03:00
Code Issues Packages Projects Releases Wiki Activity

sync code

Browse Source
This commit is contained in:
Ned Wright
2024-09-17 10:53:09 +00:00
parent 3fe0b42fcd
commit 586150fe4f
143 changed files with 1886 additions and 380 deletions
Download Patch File Download Diff File Expand all files Collapse all files

86
core/metric/generic_metric.cc
View File

@@ -26,7 +26,29 @@ using namespace ReportIS;
USE_DEBUG_FLAG(D_METRICS);
MetricCalc::MetricCalc(GenericMetric *metric, const string &title) : calc_title(title)
MetricMetadata::DotName operator"" _dot(const char *str, size_t) { return MetricMetadata::DotName{str}; }
MetricMetadata::Units operator"" _unit(const char *str, size_t) { return MetricMetadata::Units{str}; }
MetricMetadata::Description operator"" _desc(const char *str, size_t) { return MetricMetadata::Description{str}; }
string
MetricCalc::getMetadata(const string &key) const
{
auto value = metadata.find(key);
return value != metadata.end() ? value->second : "";
}
void
MetricCalc::setMetadata(const string &key, const string &value)
{
if (value.empty()) {
metadata.erase(key);
} else {
metadata[key] = value;
}
}
void
MetricCalc::addMetric(GenericMetric *metric)
{
// Only top level metric should add themselves to the metric. Nested metrics will be served by their parent.
if (metric != nullptr) metric->addCalc(this);
@@ -69,6 +91,9 @@ GenericMetric::init(
bool _force_buffering
)
{
turnOnStream(Stream::FOG);
turnOnStream(Stream::DEBUG);
i_mainloop = Singleton::Consume<I_MainLoop>::by<GenericMetric>();
i_time = Singleton::Consume<I_TimeGet>::by<GenericMetric>();
metric_name = _metric_name;
@@ -95,22 +120,10 @@ GenericMetric::init(
void
GenericMetric::handleMetricStreamSending()
{
auto metric_debug = getConfigurationWithDefault<bool>(true, "metric", "debugMetricSendEnable");
auto report_str = generateReport(false);
if (!report_str.empty() && metric_debug) {
dbgTrace(D_METRICS) << report_str;
}
if (active_streams.isSet(Stream::DEBUG)) generateDebug();
if (active_streams.isSet(Stream::FOG)) generateLog();
auto metric_fog = getConfigurationWithDefault<bool>(true, "metric", "fogMetricSendEnable");
if (!report_str.empty() && metric_fog) {
generateLog();
}
if (reset) {
for(auto &calc : calcs) {
calc->reset();
}
}
if (reset) resetMetrics();
}
string
@@ -126,24 +139,26 @@ GenericMetric::getReportInterval() const
}
string
GenericMetric::generateReport(bool with_reset)
GenericMetric::generateReport() const
{
stringstream ss;
bool any_reported_calc = false;
{
cereal::JSONOutputArchive ar(ss);
ar(cereal::make_nvp("Metric", metric_name));
ar(cereal::make_nvp("Reporting interval", report_interval.count()));
for(auto &calc : calcs) {
if (calc->wasOnceReported()) {
calc->save(ar);
if (with_reset) calc->reset();
any_reported_calc = true;
}
calc->save(ar);
}
}
return any_reported_calc ? ss.str() : "";
return ss.str();
}
void
GenericMetric::resetMetrics()
{
for(auto &calc : calcs) {
calc->reset();
}
}
void
@@ -155,16 +170,16 @@ GenericMetric::addCalc(MetricCalc *calc)
void
GenericMetric::upon(const AllMetricEvent &event)
{
auto report_str = generateReport(event.getReset());
if (!report_str.empty()) {
dbgTrace(D_METRICS) << report_str;
}
dbgTrace(D_METRICS) << generateReport();
if (event.getReset()) resetMetrics();
}
string
GenericMetric::respond(const AllMetricEvent &event)
{
return generateReport(event.getReset());
auto res = generateReport();
if (event.getReset()) resetMetrics();
return res;
}
string GenericMetric::getListenerName() const { return metric_name; }
@@ -172,6 +187,8 @@ string GenericMetric::getListenerName() const { return metric_name; }
void
GenericMetric::generateLog()
{
if (!getConfigurationWithDefault<bool>(true, "metric", "fogMetricSendEnable")) return;
set<ReportIS::Tags> tags;
Report metric_to_fog(
metric_name,
@@ -191,7 +208,7 @@ GenericMetric::generateLog()
);
for (auto &calc : calcs) {
if (calc->wasOnceReported()) metric_to_fog << calc->getLogField();
metric_to_fog << calc->getLogField();
}
if (Singleton::exists<I_Environment>()) {
@@ -227,6 +244,13 @@ GenericMetric::generateLog()
sendLog(metric_client_rest);
}
void
GenericMetric::generateDebug()
{
if (!getConfigurationWithDefault<bool>(true, "metric", "debugMetricSendEnable")) return;
dbgTrace(D_METRICS) << generateReport();
}
void
GenericMetric::sendLog(const LogRest &metric_client_rest) const
{

87
core/metric/metric_ut/metric_ut.cc
View File

@@ -20,6 +20,16 @@ using namespace MetricCalculations;
USE_DEBUG_FLAG(D_METRICS);
TEST(BaseMetric, generic_metadata)
{
Max<int> test(nullptr, "cpuMax", 0, "cpu.max"_dot, "percent"_unit, "CPU utilization percentage"_desc);
EXPECT_EQ(test.getMetricName(), "cpuMax");
EXPECT_EQ(test.getMetricDotName(), "cpu.max");
EXPECT_EQ(test.getMetircUnits(), "percent");
EXPECT_EQ(test.getMetircDescription(), "CPU utilization percentage");
}
class CPUEvent : public Event<CPUEvent>
{
public:
@@ -53,6 +63,7 @@ public:
last_report.report(event.getCPU());
avg.report(event.getCPU());
samples_counter.report(1);
total_samples_counter.report(1);
top_usage.report(event.getCPU());
}
@@ -61,6 +72,7 @@ public:
Average<double> avg{this, "cpuAvg"};
LastReportedValue<double> last_report{this, "cpuCurrent"};
Counter samples_counter{this, "cpuCounter"};
NoResetCounter total_samples_counter{this, "cpuTotalCounter"};
TopValues<double, 3> top_usage{this, "cpuTops"};
};
@@ -129,10 +141,12 @@ public:
upon(const HttpTransaction &event) override
{
avg.report(event.getUrl(), event.getBytes());
total.report(event.getUrl(), 1);
}
private:
MetricMap<string, Average<double>> avg{this, "PerUrlAvg"};
MetricMap<string, NoResetCounter> total{this, "TotalRequests"};
};
class MetricTest : public Test
@@ -189,7 +203,6 @@ TEST_F(MetricTest, basicMetricTest)
EXPECT_EQ(cpu_mt.getReportInterval().count(), 5);
routine();
EXPECT_EQ(debug_output.str(), "");
CPUEvent cpu_event;
cpu_event.setProcessCPU(89);
@@ -204,6 +217,7 @@ TEST_F(MetricTest, basicMetricTest)
" \"cpuAvg\": 89.0,\n"
" \"cpuCurrent\": 89.0,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 1,\n"
" \"cpuTops\": [\n"
" 89.0\n"
" ]\n"
@@ -249,6 +263,7 @@ TEST_F(MetricTest, basicMetricTest)
" \"cpuAvg\": 89,\n"
" \"cpuCurrent\": 89,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 1,\n"
" \"cpuTops\": [\n"
" 89.0\n"
" ]\n"
@@ -273,6 +288,7 @@ TEST_F(MetricTest, basicMetricTest)
" \"cpuAvg\": 89.5,\n"
" \"cpuCurrent\": 90.0,\n"
" \"cpuCounter\": 2,\n"
" \"cpuTotalCounter\": 2,\n"
" \"cpuTops\": [\n"
" 89.0,\n"
" 90.0\n"
@@ -318,6 +334,7 @@ TEST_F(MetricTest, basicMetricTest)
" \"cpuAvg\": 89,\n"
" \"cpuCurrent\": 90,\n"
" \"cpuCounter\": 2,\n"
" \"cpuTotalCounter\": 2,\n"
" \"cpuTops\": [\n"
" 89.0,\n"
" 90.0\n"
@@ -343,6 +360,7 @@ TEST_F(MetricTest, basicMetricTest)
" \"cpuAvg\": 93.0,\n"
" \"cpuCurrent\": 100.0,\n"
" \"cpuCounter\": 3,\n"
" \"cpuTotalCounter\": 3,\n"
" \"cpuTops\": [\n"
" 89.0,\n"
" 90.0,\n"
@@ -389,6 +407,7 @@ TEST_F(MetricTest, basicMetricTest)
" \"cpuAvg\": 93,\n"
" \"cpuCurrent\": 100,\n"
" \"cpuCounter\": 3,\n"
" \"cpuTotalCounter\": 3,\n"
" \"cpuTops\": [\n"
" 89.0,\n"
" 90.0,\n"
@@ -449,6 +468,7 @@ TEST_F(MetricTest, printMetricsTest)
" \"cpuAvg\": 89.0,\n"
" \"cpuCurrent\": 89.0,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 1,\n"
" \"cpuTops\": [\n"
" 89.0\n"
" ]\n"
@@ -481,7 +501,6 @@ TEST_F(MetricTest, metricTestWithReset)
EXPECT_EQ(cpu_mt.getReportInterval().count(), 5);
routine();
EXPECT_EQ(debug_output.str(), "");
CPUEvent cpu_event;
cpu_event.setProcessCPU(89);
@@ -496,6 +515,7 @@ TEST_F(MetricTest, metricTestWithReset)
" \"cpuAvg\": 89.0,\n"
" \"cpuCurrent\": 89.0,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 1,\n"
" \"cpuTops\": [\n"
" 89.0\n"
" ]\n"
@@ -542,6 +562,7 @@ TEST_F(MetricTest, metricTestWithReset)
" \"cpuAvg\": 89,\n"
" \"cpuCurrent\": 89,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 1,\n"
" \"cpuTops\": [\n"
" 89.0\n"
" ]\n"
@@ -566,6 +587,7 @@ TEST_F(MetricTest, metricTestWithReset)
" \"cpuAvg\": 90.0,\n"
" \"cpuCurrent\": 90.0,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 2,\n"
" \"cpuTops\": [\n"
" 90.0\n"
" ]\n"
@@ -610,6 +632,7 @@ TEST_F(MetricTest, metricTestWithReset)
" \"cpuAvg\": 90,\n"
" \"cpuCurrent\": 90,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 2,\n"
" \"cpuTops\": [\n"
" 90.0\n"
" ]\n"
@@ -634,6 +657,7 @@ TEST_F(MetricTest, metricTestWithReset)
" \"cpuAvg\": 100.0,\n"
" \"cpuCurrent\": 100.0,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 3,\n"
" \"cpuTops\": [\n"
" 100.0\n"
" ]\n"
@@ -678,6 +702,7 @@ TEST_F(MetricTest, metricTestWithReset)
" \"cpuAvg\": 100,\n"
" \"cpuCurrent\": 100,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 3,\n"
" \"cpuTops\": [\n"
" 100.0\n"
" ]\n"
@@ -707,7 +732,17 @@ TEST_F(MetricTest, generateReportWithReset)
EXPECT_EQ(cpu_mt.getReportInterval().count(), 5);
routine();
EXPECT_EQ(debug_output.str(), "");
auto init_report = cpu_mt.generateReport();
EXPECT_NE(init_report, "");
EXPECT_THAT(init_report, HasSubstr("\"Metric\": \"CPU usage\""));
EXPECT_THAT(init_report, HasSubstr("\"Reporting interval\": 5,"));
EXPECT_THAT(init_report, HasSubstr("cpuMax"));
EXPECT_THAT(init_report, HasSubstr("cpuMin"));
EXPECT_THAT(init_report, HasSubstr("cpuAvg"));
EXPECT_THAT(init_report, HasSubstr("cpuCurrent"));
EXPECT_THAT(init_report, HasSubstr("cpuTops"));
CPUEvent cpu_event;
cpu_event.setProcessCPU(89);
@@ -722,6 +757,7 @@ TEST_F(MetricTest, generateReportWithReset)
" \"cpuAvg\": 89.0,\n"
" \"cpuCurrent\": 89.0,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 1,\n"
" \"cpuTops\": [\n"
" 89.0\n"
" ]\n"
@@ -768,6 +804,7 @@ TEST_F(MetricTest, generateReportWithReset)
" \"cpuAvg\": 89,\n"
" \"cpuCurrent\": 89,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 1,\n"
" \"cpuTops\": [\n"
" 89.0\n"
" ]\n"
@@ -779,13 +816,28 @@ TEST_F(MetricTest, generateReportWithReset)
EXPECT_EQ(message_body, expected_message);
debug_output.str("");
auto report = cpu_mt.generateReport(true);
auto report = cpu_mt.generateReport();
cpu_mt.resetMetrics();
EXPECT_THAT(metric_str, HasSubstr(report));
EXPECT_EQ(message_body, expected_message);
debug_output.str("");
report = cpu_mt.generateReport();
metric_str =
"{\n"
" \"Metric\": \"CPU usage\",\n"
" \"Reporting interval\": 5,\n"
" \"cpuMax\": 0.0,\n"
" \"cpuMin\": 0.0,\n"
" \"cpuAvg\": 0.0,\n"
" \"cpuCurrent\": 0.0,\n"
" \"cpuCounter\": 0,\n"
" \"cpuTotalCounter\": 1,\n"
" \"cpuTops\": []\n"
"}";
EXPECT_EQ(report, metric_str);
debug_output.str("");
routine();
EXPECT_EQ(debug_output.str(), "");
cpu_event.setProcessCPU(90);
cpu_event.notify();
@@ -799,6 +851,7 @@ TEST_F(MetricTest, generateReportWithReset)
" \"cpuAvg\": 90.0,\n"
" \"cpuCurrent\": 90.0,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 2,\n"
" \"cpuTops\": [\n"
" 90.0\n"
" ]\n"
@@ -843,6 +896,7 @@ TEST_F(MetricTest, generateReportWithReset)
" \"cpuAvg\": 90,\n"
" \"cpuCurrent\": 90,\n"
" \"cpuCounter\": 1,\n"
" \"cpuTotalCounter\": 2,\n"
" \"cpuTops\": [\n"
" 90.0\n"
" ]\n"
@@ -867,6 +921,7 @@ TEST_F(MetricTest, generateReportWithReset)
" \"cpuAvg\": 95.0,\n"
" \"cpuCurrent\": 100.0,\n"
" \"cpuCounter\": 2,\n"
" \"cpuTotalCounter\": 3,\n"
" \"cpuTops\": [\n"
" 90.0,\n"
" 100.0\n"
@@ -912,6 +967,7 @@ TEST_F(MetricTest, generateReportWithReset)
" \"cpuAvg\": 95,\n"
" \"cpuCurrent\": 100,\n"
" \"cpuCounter\": 2,\n"
" \"cpuTotalCounter\": 3,\n"
" \"cpuTops\": [\n"
" 90.0,\n"
" 100.0\n"
@@ -987,6 +1043,7 @@ TEST_F(MetricTest, allMetricTest)
" \"cpuAvg\": 93.0,\n"
" \"cpuCurrent\": 100.0,\n"
" \"cpuCounter\": 3,\n"
" \"cpuTotalCounter\": 3,\n"
" \"cpuTops\": [\n"
" 89.0,\n"
" 90.0,\n"
@@ -1040,6 +1097,24 @@ TEST_F(MetricTest, testMapMetric)
" \"PerUrlAvg\": {\n"
" \"/index.html\": 25.0,\n"
" \"/index2.html\": 20.0\n"
" },\n"
" \"TotalRequests\": {\n"
" \"/index.html\": 2,\n"
" \"/index2.html\": 1\n"
" }\n"
"}";
EXPECT_THAT(debug_output.str(), HasSubstr(msg_str));
debug_output.str("");
routine();
msg_str =
"{\n"
" \"Metric\": \"Bytes per URL\",\n"
" \"Reporting interval\": 5,\n"
" \"PerUrlAvg\": {},\n"
" \"TotalRequests\": {\n"
" \"/index.html\": 2,\n"
" \"/index2.html\": 1\n"
" }\n"
"}";
EXPECT_THAT(debug_output.str(), HasSubstr(msg_str));