Enhancing NBI to define APIs for metric collection

[osm/Features.git] / Release6 / getting_metrics_from_NBI

diff --git a/Release6/getting_metrics_from_NBI b/Release6/getting_metrics_from_NBI
new file mode 100644 (file)
index 0000000..e65d9e9
--- /dev/null
+++ b/Release6/getting_metrics_from_NBI
@@ -0,0 +1,47 @@
+# NBI - Fetching Metrics data from Prometheus #
+
+
+
+## Proposer ##
+
+- Vijay R S (Tata Elxsi)
+
+
+
+## Type ##
+
+**Feature**
+
+
+
+## Target MDG/TF ##
+
+NBI
+
+
+
+## Description ##
+
+Enhancing NBI to define APIs for metric collection.
+NBI will achieve this by fetching the metrics from Prometheus database by using
+well-defined REST APIs of Prometheus.
+
+Following metrics of VNFs will be retrieved from Prometheus
+
+cpu_utilization
+average_memory_utilization
+disk_read_ops
+disk_write_ops
+disk_read_bytes
+disk_write_bytes
+packets_dropped_<nic number>
+packets_received
+packets_sent
+
+
+
+## Demo or definition of done ##
+
+NBI defined APIs for metric collection can be tested using Postman for the correctness
+of the data.
+Preferred data format is JSON.
\ No newline at end of file