Skip to content

Commit

Permalink
[apps] Refactored stats tables with universal printers (#1743)
Browse files Browse the repository at this point in the history
  • Loading branch information
@ethouris
ethouris committed Jan 29, 2021
1 parent 74fc74a commit 3cc7c30
Show file tree
Hide file tree
Showing 5 changed files with 252 additions and 89 deletions.
259 changes: 174 additions & 85 deletions apps/apputil.cpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -351,58 +351,157 @@ string OptionHelpItem(const OptionName& o)

// Stats module

template <class TYPE>
inline SrtStatData* make_stat(SrtStatCat cat, const string& name, const string& longname,
TYPE CBytePerfMon::*field)
{
return new SrtStatDataType<TYPE>(cat, name, longname, field);
}

#define STATX(catsuf, sname, lname, field) s.emplace_back(make_stat(SSC_##catsuf, #sname, #lname, &CBytePerfMon:: field))
#define STAT(catsuf, sname, field) STATX(catsuf, sname, field, field)

vector<unique_ptr<SrtStatData>> g_SrtStatsTable;

struct SrtStatsTableInit
{
SrtStatsTableInit(vector<unique_ptr<SrtStatData>>& s)
{
STATX(GEN, time, Time, msTimeStamp);

STAT(WINDOW, flow, pktFlowWindow);
STAT(WINDOW, congestion, pktCongestionWindow);
STAT(WINDOW, flight, pktFlightSize);

STAT(LINK, rtt, msRTT);
STAT(LINK, bandwidth, mbpsBandwidth);
STAT(LINK, maxBandwidth, mbpsMaxBW);

STAT(SEND, packets, pktSent);
STAT(SEND, packetsUnique, pktSentUnique);
STAT(SEND, packetsLost, pktSndLoss);
STAT(SEND, packetsDropped, pktSndDrop);
STAT(SEND, packetsRetransmitted, pktRetrans);
STAT(SEND, packetsFilterExtra, pktSndFilterExtra);
STAT(SEND, bytes, byteSent);
STAT(SEND, bytesUnique, byteSentUnique);
STAT(SEND, bytesDropped, byteSndDrop);
STAT(SEND, mbitRate, mbpsSendRate);
STAT(SEND, sendPeriod, usPktSndPeriod);
//STAT(SEND, msAvgResponseTime, msAvgResponseTime);
//STAT(SEND, msMaxResponseTime, msMaxResponseTime);

STAT(RECV, packets, pktRecv);
STAT(RECV, packetsUnique, pktRecvUnique);
STAT(RECV, packetsLost, pktRcvLoss);
STAT(RECV, packetsDropped, pktRcvDrop);
STAT(RECV, packetsRetransmitted, pktRcvRetrans);
STAT(RECV, packetsBelated, pktRcvBelated);
STAT(RECV, packetsFilterExtra, pktRcvFilterExtra);
STAT(RECV, packetsFilterSupply, pktRcvFilterSupply);
STAT(RECV, packetsFilterLoss, pktRcvFilterLoss);
STAT(RECV, bytes, byteRecv);
STAT(RECV, bytesUnique, byteRecvUnique);
STAT(RECV, bytesLost, byteRcvLoss);
STAT(RECV, bytesDropped, byteRcvDrop);
STAT(RECV, mbitRate, mbpsRecvRate);

}
} g_SrtStatsTableInit (g_SrtStatsTable);


#undef STAT
#undef STATX

string srt_json_cat_names [] = {
"",
"window",
"link",
"send",
"recv"
};

class SrtStatsJson : public SrtStatsWriter
{
static string keyspec(const string& name)
{
if (name == "")
return "";

return R"(")" + name + R"(":)";
}

public:
string WriteStats(int sid, const CBytePerfMon& mon) override
{
string WriteStats(int sid, const CBytePerfMon& mon) override
{
std::ostringstream output;
output << "{";
output << "\"sid\":" << sid << ",";
output << "\"time\":" << mon.msTimeStamp << ",";
output << "\"window\":{";
output << "\"flow\":" << mon.pktFlowWindow << ",";
output << "\"congestion\":" << mon.pktCongestionWindow << ",";
output << "\"flight\":" << mon.pktFlightSize;
output << "},";
output << "\"link\":{";
output << "\"rtt\":" << mon.msRTT << ",";
output << "\"bandwidth\":" << mon.mbpsBandwidth << ",";
output << "\"maxBandwidth\":" << mon.mbpsMaxBW;
output << "},";
output << "\"send\":{";
output << "\"packets\":" << mon.pktSent << ",";
output << "\"packetsUnique\":" << mon.pktSentUnique << ",";
output << "\"packetsLost\":" << mon.pktSndLoss << ",";
output << "\"packetsDropped\":" << mon.pktSndDrop << ",";
output << "\"packetsRetransmitted\":" << mon.pktRetrans << ",";
output << "\"packetsFilterExtra\":" << mon.pktSndFilterExtra << ",";
output << "\"bytes\":" << mon.byteSent << ",";
output << "\"bytesUnique\":" << mon.byteSentUnique << ",";
output << "\"bytesDropped\":" << mon.byteSndDrop << ",";
output << "\"mbitRate\":" << mon.mbpsSendRate;
output << "},";
output << "\"recv\": {";
output << "\"packets\":" << mon.pktRecv << ",";
output << "\"packetsUnique\":" << mon.pktRecvUnique << ",";
output << "\"packetsLost\":" << mon.pktRcvLoss << ",";
output << "\"packetsDropped\":" << mon.pktRcvDrop << ",";
output << "\"packetsRetransmitted\":" << mon.pktRcvRetrans << ",";
output << "\"packetsBelated\":" << mon.pktRcvBelated << ",";
output << "\"packetsFilterExtra\":" << mon.pktRcvFilterExtra << ",";
output << "\"packetsFilterSupply\":" << mon.pktRcvFilterSupply << ",";
output << "\"packetsFilterLoss\":" << mon.pktRcvFilterLoss << ",";
output << "\"bytes\":" << mon.byteRecv << ",";
output << "\"bytesUnique\":" << mon.byteRecvUnique << ",";
output << "\"bytesLost\":" << mon.byteRcvLoss << ",";
output << "\"bytesDropped\":" << mon.byteRcvDrop << ",";
output << "\"mbitRate\":" << mon.mbpsRecvRate;
output << "}";
output << "}" << endl;
static const string qt = R"(")";

string pretty_cr, pretty_tab;
if (Option("pretty"))
{
pretty_cr = "\n";
pretty_tab = "\t";
}

SrtStatCat cat = SSC_GEN;

// Do general manually
output << keyspec(srt_json_cat_names[cat]) << "{" << pretty_cr;

// SID is displayed manually
output << pretty_tab << keyspec("sid") << sid;

// Now continue with fields as specified in the table
for (auto& i: g_SrtStatsTable)
{
if (i->category == cat)
{
output << ","; // next item in same cat
output << pretty_cr;
output << pretty_tab;
if (cat != SSC_GEN)
output << pretty_tab;
}
else
{
if (cat != SSC_GEN)
{
// DO NOT close if general category, just
// enter the depth.
output << pretty_cr << pretty_tab << "}";
}
cat = i->category;
output << ",";
output << pretty_cr;
if (cat != SSC_GEN)
output << pretty_tab;

output << keyspec(srt_json_cat_names[cat]) << "{" << pretty_cr << pretty_tab;
if (cat != SSC_GEN)
output << pretty_tab;
}

// Print the current field
output << keyspec(i->name);
output << qt;
i->PrintValue(output, mon);
output << qt;
}

// Close the previous subcategory
if (cat != SSC_GEN)
{
output << pretty_cr << pretty_tab << "}" << pretty_cr;
}

// Close the general category entity
output << "}," << pretty_cr << endl;

return output.str();
}
}

string WriteBandwidth(double mbpsBandwidth) override
string WriteBandwidth(double mbpsBandwidth) override
{
std::ostringstream output;
output << "{\"bandwidth\":" << mbpsBandwidth << '}' << endl;
Expand All @@ -425,26 +524,30 @@ class SrtStatsCsv : public SrtStatsWriter
#define HAS_PUT_TIME
#endif
std::ostringstream output;

// Header
if (!first_line_printed)
{
#ifdef HAS_PUT_TIME
output << "Timepoint,";
#endif
output << "Time,SocketID,pktFlowWindow,pktCongestionWindow,pktFlightSize,";
output << "msRTT,mbpsBandwidth,mbpsMaxBW,pktSent,pktSndLoss,pktSndDrop,";
output << "pktRetrans,byteSent,byteSndDrop,mbpsSendRate,usPktSndPeriod,";
output << "pktRecv,pktRcvLoss,pktRcvDrop,pktRcvRetrans,pktRcvBelated,";
output << "byteRecv,byteRcvLoss,byteRcvDrop,mbpsRecvRate,RCVLATENCYms,";
// Filter stats
output << "pktSndFilterExtra,pktRcvFilterExtra,pktRcvFilterSupply,pktRcvFilterLoss";
output << "Time,SocketID";

for (auto& i: g_SrtStatsTable)
{
output << "," << i->longname;
}
output << endl;
first_line_printed = true;
}
int rcv_latency = 0;
int int_len = sizeof rcv_latency;
srt_getsockopt(sid, 0, SRTO_RCVLATENCY, &rcv_latency, &int_len);

// Values

#ifdef HAS_PUT_TIME
// HDR: Timepoint
// Follows ISO 8601
auto print_timestamp = [&output]() {
using namespace std;
Expand All @@ -466,37 +569,16 @@ class SrtStatsCsv : public SrtStatsWriter
print_timestamp();
#endif // HAS_PUT_TIME

output << mon.msTimeStamp << ",";
output << sid << ",";
output << mon.pktFlowWindow << ",";
output << mon.pktCongestionWindow << ",";
output << mon.pktFlightSize << ",";
output << mon.msRTT << ",";
output << mon.mbpsBandwidth << ",";
output << mon.mbpsMaxBW << ",";
output << mon.pktSent << ",";
output << mon.pktSndLoss << ",";
output << mon.pktSndDrop << ",";
output << mon.pktRetrans << ",";
output << mon.byteSent << ",";
output << mon.byteSndDrop << ",";
output << mon.mbpsSendRate << ",";
output << mon.usPktSndPeriod << ",";
output << mon.pktRecv << ",";
output << mon.pktRcvLoss << ",";
output << mon.pktRcvDrop << ",";
output << mon.pktRcvRetrans << ",";
output << mon.pktRcvBelated << ",";
output << mon.byteRecv << ",";
output << mon.byteRcvLoss << ",";
output << mon.byteRcvDrop << ",";
output << mon.mbpsRecvRate << ",";
output << rcv_latency << ",";
// Filter stats
output << mon.pktSndFilterExtra << ",";
output << mon.pktRcvFilterExtra << ",";
output << mon.pktRcvFilterSupply << ",";
output << mon.pktRcvFilterLoss; //<< ",";
// HDR: Time,SocketID
output << mon.msTimeStamp << "," << sid;

// HDR: the loop of all values in g_SrtStatsTable
for (auto& i: g_SrtStatsTable)
{
output << ",";
i->PrintValue(output, mon);
}

output << endl;
return output.str();
}
Expand Down Expand Up @@ -555,8 +637,15 @@ shared_ptr<SrtStatsWriter> SrtStatsWriterFactory(SrtStatsPrintFormat printformat
return nullptr;
}

SrtStatsPrintFormat ParsePrintFormat(string pf)
SrtStatsPrintFormat ParsePrintFormat(string pf, string& w_extras)
{
size_t havecomma = pf.find(',');
if (havecomma != string::npos)
{
w_extras = pf.substr(havecomma+1);
pf = pf.substr(0, havecomma);
}

if (pf == "default")
return SRTSTATS_PROFMAT_2COLS;

Expand Down
62 changes: 61 additions & 1 deletion apps/apputil.hpp
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
#include <memory>

#include "netinet_any.h"
#include "utilities.h"

#if _WIN32

Expand Down Expand Up @@ -314,16 +315,75 @@ enum SrtStatsPrintFormat
SRTSTATS_PROFMAT_CSV
};

SrtStatsPrintFormat ParsePrintFormat(std::string pf);
SrtStatsPrintFormat ParsePrintFormat(std::string pf, std::string& w_extras);

enum SrtStatCat
{
SSC_GEN, //< General
SSC_WINDOW, // flow/congestion window
SSC_LINK, //< Link data
SSC_SEND, //< Sending
SSC_RECV //< Receiving
};

struct SrtStatData
{
SrtStatCat category;
std::string name;
std::string longname;

SrtStatData(SrtStatCat cat, std::string n, std::string l): category(cat), name(n), longname(l) {}

virtual void PrintValue(std::ostream& str, const CBytePerfMon& mon) = 0;
};

template <class TYPE>
struct SrtStatDataType: public SrtStatData
{
typedef TYPE CBytePerfMon::*pfield_t;
pfield_t pfield;

SrtStatDataType(SrtStatCat cat, const std::string& name, const std::string& longname, pfield_t field)
: SrtStatData (cat, name, longname), pfield(field)
{
}

void PrintValue(std::ostream& str, const CBytePerfMon& mon) override
{
str << mon.*pfield;
}
};

class SrtStatsWriter
{
public:
virtual std::string WriteStats(int sid, const CBytePerfMon& mon) = 0;
virtual std::string WriteBandwidth(double mbpsBandwidth) = 0;
virtual ~SrtStatsWriter() { };

void Option(const std::string& key, const std::string& val)
{
options[key] = val;
}

bool Option(const std::string& key, std::string* rval = nullptr)
{
const std::string* out = map_getp(options, key);
if (!out)
return false;

if (rval)
*rval = *out;
return true;
}

protected:
std::map<std::string, std::string> options;

};

extern std::vector<std::unique_ptr<SrtStatData>> g_SrtStatsTable;

std::shared_ptr<SrtStatsWriter> SrtStatsWriterFactory(SrtStatsPrintFormat printformat);


Expand Down
Loading

0 comments on commit 3cc7c30

Please sign in to comment.