vnfs/VES5.0/evel/evel-library/code/VESreporting_fault/README.md

   1
   2 PROJECT DESCRIPTION
   3
   4 ---
   5 This project contains the source code and scripts for the generation of fault events. The folder contains:
   6
   7  - README.md: this file.
   8
   9  - LICENSE.TXT: the license text.
  10
  11  - 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.
  12
  13  - Makefile: makefile that compiles ves_fault_reporter.c and generates ves_fault_reporter binary.
  14
  15  - 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.
  16
  17
  18 USAGE
  19 -----
  20
  21 Update the configuration files with proper parameters values so that events generated would contain those values
  22
  23 To run the ves_fault_reporter in single collector configuration, please execute the following steps:
  24
  25  - Make the go-client.sh script executable
  26         chmod +x go-client.sh
  27
  28  - Run the go-client.sh script
  29         ./go-client.sh
  30
  31 For 2 collectors configuration, please execute following steps:
  32
  33  - Make the go-client.sh script executable
  34         chmod +x go-client_2_collectors.sh
  35
  36  - Run the go-client_2_collectors.sh script
  37         ./go-client_2_collectors.sh