Contribute C++ implement of VES spec 7.0.1 to ONAP/vnfsdk:

Part1: document

Issue-ID: VNFSDK-466

Signed-off-by: Yatian XU <yatian.xu@nokia-sbell.com>
Change-Id: Ib9ac5dd20895383b3150e475c119484cd7c17dc6

7 files changed, 309 insertions, 0 deletions

diff --git a/veslibrary/ves_cpplibrary/README.md b/veslibrary/ves_cpplibrary/README.md
new file mode 100644
index 0000000..a03dfa0
--- /dev/null
+++ b/veslibrary/ves_cpplibrary/README.md
@@ -0,0 +1,309 @@
+# A C++ implement of VES Spec
+===
+C++ libraries provides 2 independent modules:
+* **xencode**: encode structure event to json string.
+* **xtransport**: post json string to collector.
+![Layered Architecture](doc/images/arch.png)
+# Build
+
+## build dependency
+[**json**](https://github.com/nlohmann/json) for encoding.
+```
+git clone https://github.com/nlohmann/json.git
+cd json
+mkdir _build
+cd _build
+cmake .. -DJSON_BuildTests=OFF
+make
+make install
+```
+[**spdlog**](https://github.com/gabime/spdlog) for logging.
+```
+git clone https://github.com/gabime/spdlog.git
+cd spdlog
+mkdir _build
+cd _build
+cmake .. -DSPDLOG_BUILD_EXAMPLES=OFF -DSPDLOG_BUILD_BENCH=OFF -DSPDLOG_BUILD_TESTS=OFF
+make
+make install
+```
+[**thrift**](https://github.com/apache/thrift) for RPC.
+```
+git clone https://github.com/apache/thrift.git
+cd thrift
+mkdir _build
+cd _build
+cmake .. -DBUILD_PYTHON=OFF -DBUILD_JAVA=OFF -DBUILD_C_GLIB=OFF -DWITH_LIBEVENT=OFF -DWITH_ZLIB=OFF -DWITH_OPENSSL=OFF -DBUILD_TESTING=OFF -DCMAKE_POSITION_INDEPENDENT_CODE=ON
+make
+make install
+```
+[**leveldb**](https://github.com/google/leveldb) for buffering.
+```
+git clone https://github.com/google/leveldb.git
+mkdir _build
+cd _build
+cmake .. -DCMAKE_POSITION_INDEPENDENT_CODE=ON
+make
+make install
+```
+
+## build xencode and xtransport
+```
+cd ves_cpplibrary/src/
+mkdir _build
+cd _build
+cmake ..
+make
+make install
+```
+
+# Usage samples:
+## Build event(fault)
+``` c++
+    auto header = XCommonEventHeader::create(
+        "EventName",
+        "EventId",
+        "SourceName",
+        "ReportName",
+        XEnumCommonEventHeaderPriorityNormal,
+        111
+        );
+
+    auto fault = XFaultFields::create(header,
+        "condition",
+        "specProblem",
+        XEnumFaultFieldsEventSourceTypeVirtualMachine,
+        XEnumFaultFieldsEventSeverityNORMAL,
+        XEnumFaultFieldsVfStatusActive);
+
+    fault->setAlarmInterfaceA("Interface");
+    fault->setEventSeverity(XEnumFaultFieldsEventSeverityMAJOR);
+    fault->setAlarmCondition("XXCondition");
+    fault->setVfStatus(XEnumFaultFieldsVfStatusRequestingTermination);
+    fault->setEventCategory("Category");
+    fault->setEventSourceType(XEnumFaultFieldsEventSourceTypeVirtualMachine);
+    fault->setSpecificProblem("XXProblem");
+    XHashMap hm{ { "xxx","123" },{ "yyy","456" } };
+    fault->setAlarmAdditionalInformation(hm);
+
+    cout << fault->toString() << endl;
+```
+## Post fault to collector
+![CurlTransport](doc/images/CurlTransport.png)
+``` c++
+void testLibcurlTransport()
+{
+    auto event = buildFault();
+
+    XTransportOption opt;
+    opt.url_ = "http://127.0.0.1:30000";
+
+    auto transport = XTransport::LibCurlTransport(opt);
+
+    transport->start();
+
+    transport->post(event->toString());
+
+    transport->stop();
+}
+```
+## Post fault to collector(with retry)
+![RetryTransport](doc/images/RetryTransport.png)
+``` c++
+void testRetryTransport()
+{
+    auto event = buildFault();
+
+    XTransportOption opt;
+    opt.url_ = "http://127.0.0.1:30000";
+
+    auto transport = XTransport::RetryTransport(XTransport::LibCurlTransport(opt),
+        seconds(3),
+        5);
+
+    transport->start();
+
+    for (int i=0; i<10; i++)
+    {
+        transport->post(event->toString());
+        this_thread::sleep_for(seconds(10));
+    }
+
+    transport->stop();
+}
+```
+## Post fault to collector(with retry and switch)
+![SwitchableTransport](doc/images/SwitchableTransport.png)
+``` c++
+void testSwitchableTransport()
+{
+    auto event = buildFault();
+
+    vector<shared_ptr<XTransport>> transports;
+
+    XTransportOption opt;
+    opt.url_ = "http://127.0.0.1:30000";
+    auto transport1 = XTransport::RetryTransport(XTransport::LibCurlTransport(opt), 
+        seconds(3), 
+        3);
+    transports.push_back(transport1);
+
+    opt.url_ = "http://127.0.0.1:30001";
+    auto transport2 = XTransport::RetryTransport(XTransport::LibCurlTransport(opt), 
+        seconds(3), 
+        3);
+    transports.push_back(transport2);
+
+    auto transport = XTransport::SwitchableTransport(transports);
+
+    transport->start();
+
+    for (int i=0; i<10; i++)
+    {
+        transport->post(event->toString());
+        this_thread::sleep_for(seconds(10));
+    }
+
+    transport->stop();
+}
+``` 
+## Post fault to collector(with buffer)
+![BufferedTransport](doc/images/BufferedTransport.png)
+``` c++
+void testMemBufferedTransport()
+{
+    auto event = buildFault();
+
+    vector<shared_ptr<XTransport>> transports;
+
+    XTransportOption opt;
+    opt.url_ = "http://127.0.0.1:30000";
+    auto transport1 = XTransport::RetryTransport(XTransport::LibCurlTransport(opt), 
+        seconds(3), 
+        3);
+    transports.push_back(transport1);
+
+    opt.url_ = "http://127.0.0.1:30001";
+    auto transport2 = XTransport::RetryTransport(XTransport::LibCurlTransport(opt), 
+        seconds(3), 
+        3);
+    transports.push_back(transport2);
+
+    auto que = XQueue::create(1000);
+    auto transport = XTransport::BufferedTransport(XTransport::SwitchableTransport(transports),
+        que);
+
+    transport->start();
+
+    for (int i=0; i<1200; i++)
+    {
+        transport->post(event->toString());
+    }
+
+    this_thread::sleep_for(seconds(10));
+
+    transport->stop();
+}
+
+void testDiskBufferedTransport()
+{
+    auto event = buildFault();
+
+    vector<shared_ptr<XTransport>> transports;
+
+    XTransportOption opt;
+    opt.url_ = "http://127.0.0.1:30000";
+    auto transport1 = XTransport::RetryTransport(XTransport::LibCurlTransport(opt), 
+        seconds(3), 
+        3);
+    transports.push_back(transport1);
+
+    opt.url_ = "http://127.0.0.1:30001";
+    auto transport2 = XTransport::RetryTransport(XTransport::LibCurlTransport(opt), 
+        seconds(3), 
+        3);
+    transports.push_back(transport2);
+
+    auto que = XQueue::create("/tmp");
+    auto transport = XTransport::BufferedTransport(XTransport::SwitchableTransport(transports),
+        que);
+
+    transport->start();
+
+    for (int i=0; i<10000; i++)
+    {
+        transport->post(event->toString());
+    }
+
+    this_thread::sleep_for(seconds(30));
+
+    transport->stop();
+}
+```
+## Post fault via agent
+![RpcTransport](doc/images/RpcTransport.png)
+client
+``` c++
+void testRpcClientTransport()
+{
+    auto event = buildFault();
+
+    XTransportOption rpcOpt;
+    rpcOpt.host_ = "127.0.0.1";
+    rpcOpt.port_ = 5678;
+
+    auto retryTransport = XTransport::RetryTransport(XTransport::RpcClientTransport(rpcOpt),
+        seconds(3),
+        5);
+    auto transport = XTransport::BufferedTransport(retryTransport, 
+        XQueue::create(1000)
+        );
+
+    transport->start();
+
+    for (int i=0; i<100; i++)
+    {
+        transport->post(event->toString());
+        this_thread::sleep_for(milliseconds(200));
+    }
+
+    this_thread::sleep_for(seconds(10));
+
+    transport->stop();
+}
+```
+server (agent)
+``` c++
+void testRpcServerTransport()
+{
+    vector<shared_ptr<XTransport>> transports;
+
+    XTransportOption opt;
+    opt.url_ = "http://127.0.0.1:30000";
+    auto transport1 = XTransport::RetryTransport(XTransport::LibCurlTransport(opt), 
+        seconds(3), 
+        3);
+    transports.push_back(transport1);
+
+    opt.url_ = "http://127.0.0.1:30001";
+    auto transport2 = XTransport::RetryTransport(XTransport::LibCurlTransport(opt), 
+        seconds(3), 
+        3);
+    transports.push_back(transport2);
+
+    auto que = XQueue::create("/tmp");
+    auto bufferedTransport = XTransport::BufferedTransport(XTransport::SwitchableTransport(transports),
+        que);
+
+    XTransportOption rpcOpt;
+    rpcOpt.port_ = 5678;
+
+    auto transport = XTransport::RpcServerTransport(bufferedTransport, rpcOpt);
+
+    transport->start();
+
+    this_thread::sleep_for(minutes(10));
+
+    transport->stop();
+} 
+```
diff --git a/veslibrary/ves_cpplibrary/doc/images/BufferedTransport.png b/veslibrary/ves_cpplibrary/doc/images/BufferedTransport.png
new file mode 100755
index 0000000..7708d3f
--- /dev/null
+++ b/veslibrary/ves_cpplibrary/doc/images/BufferedTransport.png
diff --git a/veslibrary/ves_cpplibrary/doc/images/CurlTransport.png b/veslibrary/ves_cpplibrary/doc/images/CurlTransport.png
new file mode 100755
index 0000000..819a3bd
--- /dev/null
+++ b/veslibrary/ves_cpplibrary/doc/images/CurlTransport.png
diff --git a/veslibrary/ves_cpplibrary/doc/images/RetryTransport.png b/veslibrary/ves_cpplibrary/doc/images/RetryTransport.png
new file mode 100755
index 0000000..f306d0d
--- /dev/null
+++ b/veslibrary/ves_cpplibrary/doc/images/RetryTransport.png
diff --git a/veslibrary/ves_cpplibrary/doc/images/RpcTransport.png b/veslibrary/ves_cpplibrary/doc/images/RpcTransport.png
new file mode 100755
index 0000000..87c20ed
--- /dev/null
+++ b/veslibrary/ves_cpplibrary/doc/images/RpcTransport.png
diff --git a/veslibrary/ves_cpplibrary/doc/images/SwitchableTransport.png b/veslibrary/ves_cpplibrary/doc/images/SwitchableTransport.png
new file mode 100755
index 0000000..2f15f79
--- /dev/null
+++ b/veslibrary/ves_cpplibrary/doc/images/SwitchableTransport.png
diff --git a/veslibrary/ves_cpplibrary/doc/images/arch.png b/veslibrary/ves_cpplibrary/doc/images/arch.png
new file mode 100755
index 0000000..265d298
--- /dev/null
+++ b/veslibrary/ves_cpplibrary/doc/images/arch.png