VES EVEL Library VES 5.4.1 enhancements

HB-Fault-Measurement-Syslog-2Collector enhancement.
Issue-ID: CERT-17

Change-Id: Ieff01ee5461e50c7e7d07d10ec66c1c97cf8c5b1
Signed-off-by: PrakashH <pbhandar@techmahindra.com>

1 files changed, 37 insertions, 0 deletions

diff --git a/vnfs/VES5.0/evel/evel-library/code/VESreporting_fault/README.md b/vnfs/VES5.0/evel/evel-library/code/VESreporting_fault/README.md
new file mode 100644
index 00000000..5a7ea414
--- /dev/null
+++ b/vnfs/VES5.0/evel/evel-library/code/VESreporting_fault/README.md
@@ -0,0 +1,37 @@
+
+PROJECT DESCRIPTION
+
+---
+This project contains the source code and scripts for the generation of fault events. The folder contains:
+
+ - README.md: this file.
+
+ - LICENSE.TXT: the license text.
+
+ - ves_fault_reporter.c and other .c files: source code that uses the ECOMP Vendor Event Listener Library (VES) to generate the fault events. Fault is generated based on the link status. If number of bytes transmitted/received is less than the low water mark, the fault is generated. The application reads flt_config.json file for parameter values and poppulate the fault event. If eventName, eventSourceType, vfStatus, specificProblem or alarmCondition parameter value is not given, the application terminates. If reportingEntityName and sourceName parameter values are not given, then it gets the hostname and poppulates it. If tmp_faultCheckInterval is not given, it defaults to 60 seconds. 
+
+ - Makefile: makefile that compiles ves_fault_reporter.c and generates ves_fault_reporter binary.
+
+ - go-client.sh/go-client_2_collectors.sh: bash script that starts up the ves_fault_reporter. It reads input parameters like DCAE IP address and port from configuration files contained in /opt/config. Based on the collector configuration, use go-client.sh for single collector configuration, or use go-client_2_collectors.sh for 2 collectors configuration.
+
+
+USAGE
+-----
+
+Update the configuration files with proper parameters values so that events generated would contain those values
+
+To run the ves_fault_reporter in single collector configuration, please execute the following steps:
+
+ - Make the go-client.sh script executable
+        chmod +x go-client.sh
+
+ - Run the go-client.sh script
+        ./go-client.sh  
+
+For 2 collectors configuration, please execute following steps:
+
+ - Make the go-client.sh script executable
+        chmod +x go-client_2_collectors.sh
+
+ - Run the go-client_2_collectors.sh script
+        ./go-client_2_collectors.sh