From af7aa682517d3ccaace9a089194e6a4333f4cdaa Mon Sep 17 00:00:00 2001 From: PrakashH Date: Mon, 28 Jan 2019 17:14:52 +0000 Subject: 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 --- .../code/VESreporting_syslog/README.md | 37 ++++++++++++++++++++++ 1 file changed, 37 insertions(+) create mode 100644 vnfs/VES5.0/evel/evel-library/code/VESreporting_syslog/README.md (limited to 'vnfs/VES5.0/evel/evel-library/code/VESreporting_syslog/README.md') diff --git a/vnfs/VES5.0/evel/evel-library/code/VESreporting_syslog/README.md b/vnfs/VES5.0/evel/evel-library/code/VESreporting_syslog/README.md new file mode 100644 index 00000000..9aecc2ac --- /dev/null +++ b/vnfs/VES5.0/evel/evel-library/code/VESreporting_syslog/README.md @@ -0,0 +1,37 @@ + +PROJECT DESCRIPTION + +--- +This project contains the source code and scripts for the generation of syslog events. The folder contains: + + - README.md: this file. + + - LICENSE.TXT: the license text. + + - ves_syslog_reporter.c and other .c files: source code that uses the ECOMP Vendor Event Listener Library (VES) to generate the syslog events. Syslog events are generated based on /var/log/syslog entries. If a specific pattern is observed in the syslog file, then it generates the syslog event. The application reads syslog_config.json file for parameter values and poppulate the syslog event. If eventName, eventSourceType, syslogTag and tmp_syslogFile parameter value is not given, the application terminates. If reportingEntityName and/or sourceName parameter values are not given, then it gets the hostname and poppulates it. + + - Makefile: makefile that compiles ves_syslog_reporter.c and generates ves_syslog_reporter binary. + + - go-client.sh/go-client_2_collectors.sh: bash script that starts up the ves_syslog_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_syslog_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 -- cgit 1.2.3-korg