From bf1197da4ad12c5e8d05e6e1e1d0cf9480288d50 Mon Sep 17 00:00:00 2001
From: MJB <mjb@it-innovation.soton.ac.uk>
Date: Sat, 23 Dec 2017 13:12:29 +0000
Subject: [PATCH] update to docs

---
 docs/monitoring.md | 84 ++++++++++++++++++++++++++++++++++++----------
 1 file changed, 67 insertions(+), 17 deletions(-)

diff --git a/docs/monitoring.md b/docs/monitoring.md
index 46abaa0..e1f3309 100644
--- a/docs/monitoring.md
+++ b/docs/monitoring.md
@@ -205,9 +205,7 @@ If the agent is deployed in a VM/container that a tenant has root access then a
 |Platform|nap_fqdn_perf|fqdn request rate and latency|
 |Platform|orchestrator|---|
 |Platform|clmc|---|
-|Media Service|res_alloc|compute resources allocated to a VM|
-|Media Service|network_io|vm port network io and error at L2|
-|Media Service|service|vm service perf|
+|Media Service|vm_host_config|compute resources allocated to a VM|
 |Media Service|cpu_usage|vm desc|
 |Media Service|disk_usage|vm desc|
 |Media Service|disk_IO|vm desc|
@@ -216,6 +214,9 @@ If the agent is deployed in a VM/container that a tenant has root access then a
 |Media Service|process_status|vm desc|
 |Media Service|swap_memory_usage|vm desc|
 |Media Service|system_load_uptime|vm desc|
+|Media Service|net_port_config|networking constraints on port on a VM|
+|Media Service|net_port_io|vm port network io and error at L2|
+|Media Service|service|vm service perf|
 
 #### Infrastructure Capacity Measurements
 
@@ -284,15 +285,31 @@ Fields
 * HTTP_REQUESTS_FQDN_M
 * NETWORK_FQDN_LATENCY
 
-**orch_media_service**
+**clmc**
+
+#### Media Service Measurements
 
-**orch_sfc_instance**
+**media_service**
 
-**orch_sf_instance**
+Aggregate measurement derived from VM/container measurements, most likely calculated using a continuous query of a specific time interval
 
-**clmc**
+**sfc**
 
-#### Media Service Measurements
+Aggregate measurement derived from VM/container measurements, most likely calculated using a continuous query of a specific time interval
+
+**sf**
+
+Aggregate measurement derived from VM/container measurements, most likely calculated using a continuous query of a specific time interval
+
+**sfc_instance**
+
+Aggregate measurement derived from VM/container measurements, most likely calculated using a continuous query of a specific time interval
+
+**sf_instance**
+
+Aggregate measurement derived from VM/container measurements, most likely calculated using a continuous query of a specific time interval
+
+#### VM/Container Measurements
 
 Common tags
 
@@ -306,15 +323,26 @@ Common tags
 
 ##### Network Measurements
 
-**network_allocation**
+**net_port_config**
+
+network config is concerned with any network io allocation/constraints for network rx/tx
+
+`net_port_config,<common_tags>,port_state="",port_id="" <fields> timestamp`
 
 Possible Fields
 
-* bandwidth
+* RX_USAGE
+* TX_USAGE
+* RX_THROUGHPUT
+* TX_THROUGHPUT
+
+Specific tags
+* port_state
+* port_id
 
-**network_io**
+**net_port_io**
 
-`network_io,<common_tags>,port_state="",port_id="" <fields> timestamp`
+`network_io,<common_tags>,port_id="" <fields> timestamp`
 
 Fields
 
@@ -327,16 +355,20 @@ Fields
 
 Note that RX_PACKETS_M seems to have inconsistent naming convention. 
 
-##### Host Measurements
+##### VM Host Measurements
 
 SF Host Resource Measurements measures the host resources allocated to a service function deployed by the platform. All measurements have the following global tags to allow the data to be sliced and diced according to dimensions.
 
-**node_resource**
+**vm_host_config**
 
 The resources allocated to a VM/Container
 
 `res_alloc,<global-tags> cpu,memory,storage timestamp`
 
+Specific tags
+
+* node_state
+
 **cpu_usage**
 
 [[inputs.cpu]]
@@ -371,11 +403,21 @@ The resources allocated to a VM/Container
 
 ##### Service Measurements
 
+**<prefix>_service_config**
+
+Fields
+* <tbd>
+
+Specific Tags
+* service_state
+
+**<prefix>_service_perf**
+
 Each SF developed will measure service specific usage and performance measurements. The following are provided as examples or common service metrics.
 
 `service,<global_tags>,cont_nav="",cont_rep="",user="" <fields> timestamp`
 
-Fields
+Fields (examples)
 
 * request_rate
 * response_time
@@ -416,7 +458,13 @@ The following fields relate to CID which I don't understand but jitter is an imp
 * RX_BYTES_CID_M 
 * TX_BYTES_CID_M 
 
-What do we do with the configuration states for nodes, links and ports? Do we put this as tags or are these separate series.
+What about links? What about links between different media service nodes
+
+#### Link Measurements
+
+links are established between VM/container instances, need to discuss what measurements make sense. Also the context for links could be between media services, therefore a link measurement should be within the platform context and NOT the media service context. Need a couple of scenarios to work this one out.
+
+**link_config**
 
 Link Tags
 
@@ -425,4 +473,6 @@ Link Tags
 * source_node_id
 * destination_node_id
 * link_type
-* link_state
\ No newline at end of file
+* link_state
+
+**link_perf**
\ No newline at end of file
-- 
GitLab