Merge pull request #269 from CESNET/plugins-usage

Add usage to all plugins

Author: SiskaPavel

src/core/ipfixprobe.cpp

@@ -94,7 +94,7 @@ static void printPluginsUsage(const std::vector<PluginManifest>& pluginsManifest
 		} else {
 			std::cout << pluginManifest.name << std::endl;
 		}
-		std::cout << "------------------\n";
+		std::cout << std::endl;
 	}
 }
 

src/plugins/process/basicplus/src/basicplus.cpp

@@ -24,7 +24,13 @@ static const PluginManifest basicplusPluginManifest = {
 	.description = "Basicplus process plugin for parsing basicplus traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser(
+				"basicplus",
+				"Extend basic fields with TTL, TCP window, options, MSS and SYN size");
+			parser.usage(std::cout);
+		},
 };
 
 BASICPLUSPlugin::BASICPLUSPlugin(const std::string& params, int pluginID)

src/plugins/process/bstats/src/bstats.cpp

@@ -24,7 +24,11 @@ static const PluginManifest bstatsPluginManifest = {
 	.description = "Bstats process plugin for computing packet bursts stats.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("bstats", "Compute packet bursts stats");
+			parser.usage(std::cout);
+		},
 };
 
 const struct timeval BSTATSPlugin::min_packet_in_burst

src/plugins/process/dns/src/dns.cpp

@@ -32,7 +32,11 @@ static const PluginManifest dnsPluginManifest = {
 	.description = "Dns process plugin for parsing dns traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("dns", "Parse DNS traffic");
+			parser.usage(std::cout);
+		},
 };
 // #define DEBUG_DNS
 

src/plugins/process/flowHash/src/flow_hash.cpp

@@ -24,7 +24,11 @@ static const PluginManifest flowhashPluginManifest = {
 	.description = "flowhash process plugin for parsing flowhash value.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("flowhash", "Export flow hash as flow id");
+			parser.usage(std::cout);
+		},
 };
 
 FLOW_HASHPlugin::FLOW_HASHPlugin(const std::string& params, int pluginID)

src/plugins/process/http/src/http.cpp

@@ -32,7 +32,11 @@ static const PluginManifest httpPluginManifest = {
 	.description = "http process plugin for parsing http traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("http", "Parse HTTP traffic");
+			parser.usage(std::cout);
+		},
 };
 
 // #define DEBUG_HTTP

src/plugins/process/icmp/src/icmp.cpp

@@ -24,7 +24,11 @@ static const PluginManifest icmpPluginManifest = {
 	.description = "ICMP process plugin for parsing icmp traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("icmp", "Parse ICMP traffic");
+			parser.usage(std::cout);
+		},
 };
 
 ICMPPlugin::ICMPPlugin(const std::string& params, int pluginID)

src/plugins/process/idpContent/src/idpcontent.cpp

@@ -24,7 +24,11 @@ static const PluginManifest idpcontentPluginManifest = {
 	.description = "Idpcontent process plugin for parsing idpcontent traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("idpcontent", "Parse first bytes of flow payload");
+			parser.usage(std::cout);
+		},
 };
 
 #define MIN(a, b) (((a) < (b)) ? (a) : (b))

src/plugins/process/mpls/src/mpls.cpp

@@ -24,7 +24,11 @@ static const PluginManifest mplsPluginManifest = {
 	.description = "Mpls process plugin for parsing mpls traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("mpls", "Parse MPLS traffic");
+			parser.usage(std::cout);
+		},
 };
 
 MPLSPlugin::MPLSPlugin(const std::string& params, int pluginID)

src/plugins/process/netbios/src/netbios.cpp

@@ -28,7 +28,11 @@ static const PluginManifest netbiosPluginManifest = {
 	.description = "Netbios process plugin for parsing netbios traffic.",
 	.pluginVersion = "1.0.0",
 	.apiVersion = "1.0.0",
-	.usage = nullptr,
+	.usage =
+		[]() {
+			OptionsParser parser("netbios", "Parse netbios traffic");
+			parser.usage(std::cout);
+		},
 };
 NETBIOSPlugin::NETBIOSPlugin(const std::string& params, int pluginID)
 	: ProcessPlugin(pluginID)