VES EVEL Library VES 5.4.1 enhancements
[demo.git] / vnfs / VES5.0 / evel / evel-library / code / VESreporting_vFW / README.md
1
2 PROJECT DESCRIPTION
3
4 ---
5 This project contains the source code and scripts for the periodic generation of measurement events. The folder contains:
6
7  - README.md: this file.
8
9  - LICENSE.TXT: the license text.
10
11  - vpp_measurement_reporter.c and other .c files: source code that uses the ECOMP Vendor Event Listener Library (VES) to generate the measurement events. Measurement event is generated periodically on each of the interfaces. It gives the number of bytes/packets that transmitted/received. The application reads meas_config.json file for parameter values and poppulate the measurement event. If eventName 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 measurementInterval is not given, it defaults to 60 seconds. 
12
13  - Makefile: makefile that compiles vpp_measurement_reporter.c and generates vpp_measurement_reporter binary.
14
15  - go-client.sh/go-client_2_collectors.sh: bash script that starts up the vpp_measurement_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 vpp_measurement_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