Merge "Update HV-VES documentation"

4 files changed, 124 insertions, 0 deletions

diff --git a/docs/sections/services/ves-hv/resources/ONAP_VES_HV_Architecture.png b/docs/sections/services/ves-hv/resources/ONAP_VES_HV_Architecture.png
new file mode 100644
index 00000000..7652b970
--- /dev/null
+++ b/docs/sections/services/ves-hv/resources/ONAP_VES_HV_Architecture.png
diff --git a/docs/sections/services/ves-hv/resources/WTP.yaml b/docs/sections/services/ves-hv/resources/WTP.yaml
new file mode 100644
index 00000000..835ab309
--- /dev/null
+++ b/docs/sections/services/ves-hv/resources/WTP.yaml
@@ -0,0 +1,45 @@
+WTP:
+  -- direct encoding using ASN.1 notation - WTP.asn
+  magic: 0xAA
+  versionMajor: 0x01
+  versionMinor: 0x00
+  reserved: 0x00 0x00 0x00
+  payloadId: 0x00 0x01
+  -- payloadLength set to the highest value 1MiB = 1024 * 1024 = 1048576 B
+  payloadLength: 0x00 0x10 0x00 0x00
+  payload:
+    -- GPB encoded payload - VesEvent.proto
+      commonEventHeader:
+        version: "1.0"
+        domain: "perf3gpp"
+        sequence: 0
+        priority: 1
+        eventId: "sampleEventId01"
+        eventName: "sampleEventName01"
+        lastEpochMicrosec: 120034455
+        startEpochMicrosec: 120034455
+        reportingEntityName: "sampleEntityName"
+        sourceName: "sampleSourceName"
+        vesEventListenerVersion: "anotherVersion"
+      eventFields:
+        -- GPB encoded fields for perf3gpp domain - Perf3gppFields.proto
+        perf3gppFieldsVersion: "1.0"
+        measDataCollection:
+          -- GPB encoded RTPM - MeasDataCollection.proto
+          formatVersion: "28.550 2.0"
+          granularityPeriod: 5
+          measuredEntityUserName: "sampleEntityUserName"
+          measuredEntityDn: "sampleEntityDn"
+          measuredEntitySoftwareVersion: "1.0"
+          measInfo:
+            - measInfo1:
+              iMeasInfoId: 1
+              iMeasTypes: 1
+              jobId: "sampleJobId"
+              measValues:
+                - measValue1:
+                  measObjInstIdListIdx: 1
+                  measResults:
+                    p: 0
+                    sint64 iValue: 63888
+                    suspectFlag: false
diff --git a/docs/sections/services/ves-hv/resources/base-configuration.json b/docs/sections/services/ves-hv/resources/base-configuration.json
new file mode 100644
index 00000000..6580287d
--- /dev/null
+++ b/docs/sections/services/ves-hv/resources/base-configuration.json
@@ -0,0 +1,12 @@
+{
+  "logLevel": "INFO",
+  "server.listenPort": 6061,
+  "server.idleTimeoutSec": 60,
+  "cbs.firstRequestDelaySec": 10,
+  "cbs.requestIntervalSec": 5,
+  "security.sslDisable": false,
+  "security.keys.keyStoreFile": "/etc/ves-hv/ssl/server.p12",
+  "security.keys.keyStorePasswordFile": "/etc/ves-hv/ssl/server.pass",
+  "security.keys.trustStoreFile": "/etc/ves-hv/ssl/trust.p12",
+  "security.keys.trustStorePasswordFile": "/etc/ves-hv/ssl/trust.pass"
+}
\ No newline at end of file
diff --git a/docs/sections/services/ves-hv/resources/metrics_sample_response.txt b/docs/sections/services/ves-hv/resources/metrics_sample_response.txt
new file mode 100644
index 00000000..da54e3ea
--- /dev/null
+++ b/docs/sections/services/ves-hv/resources/metrics_sample_response.txt
@@ -0,0 +1,67 @@
+jvm_threads_live 26.0
+system_cpu_count 4.0
+jvm_gc_memory_promoted_bytes_total 6740576.0
+process_cpu_usage 5.485463521667581E-4
+jvm_buffer_count{id="mapped",} 0.0
+jvm_buffer_count{id="direct",} 14.0
+jvm_threads_peak 26.0
+jvm_classes_unloaded_total 0.0
+hvves_clients_rejected_cause_total{cause="too_big_payload",} 7.0
+hvves_messages_sent_topic_total{topic="HV_VES_PERF3GPP",} 20000.0
+jvm_threads_daemon 25.0
+jvm_buffer_memory_used_bytes{id="mapped",} 0.0
+jvm_buffer_memory_used_bytes{id="direct",} 1.34242446E8
+jvm_gc_max_data_size_bytes 4.175429632E9
+hvves_messages_received_total 32000.0
+hvves_messages_dropped_total 12000.0
+hvves_clients_rejected_total 7.0
+system_cpu_usage 0.36204059243006037
+jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'non-nmethods'",} 5832704.0
+jvm_memory_max_bytes{area="nonheap",id="Metaspace",} -1.0
+jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'",} 1.22912768E8
+jvm_memory_max_bytes{area="nonheap",id="Compressed Class Space",} 1.073741824E9
+jvm_memory_max_bytes{area="heap",id="G1 Eden Space",} -1.0
+jvm_memory_max_bytes{area="heap",id="G1 Old Gen",} 4.175429632E9
+jvm_memory_max_bytes{area="heap",id="G1 Survivor Space",} -1.0
+jvm_memory_max_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'",} 1.22912768E8
+hvves_messages_dropped_cause_total{cause="invalid",} 12000.0
+hvves_messages_received_payload_bytes_total 1.0023702E7
+jvm_buffer_total_capacity_bytes{id="mapped",} 0.0
+jvm_buffer_total_capacity_bytes{id="direct",} 1.34242445E8
+system_load_average_1m 2.77
+hvves_data_received_bytes_total 1.052239E7
+jvm_gc_pause_seconds_count{action="end of minor GC",cause="Metadata GC Threshold",} 2.0
+jvm_gc_pause_seconds_sum{action="end of minor GC",cause="Metadata GC Threshold",} 0.087
+jvm_gc_pause_seconds_count{action="end of minor GC",cause="G1 Evacuation Pause",} 8.0
+jvm_gc_pause_seconds_sum{action="end of minor GC",cause="G1 Evacuation Pause",} 0.218
+jvm_gc_pause_seconds_max{action="end of minor GC",cause="Metadata GC Threshold",} 0.03
+jvm_gc_pause_seconds_max{action="end of minor GC",cause="G1 Evacuation Pause",} 0.031
+hvves_messages_processing_time_seconds_max 0.114395
+hvves_messages_processing_time_seconds_count 20000.0
+hvves_messages_processing_time_seconds_sum 280.282544
+hvves_disconnections_total 11.0
+jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-nmethods'",} 1312640.0
+jvm_memory_used_bytes{area="nonheap",id="Metaspace",} 3.624124E7
+jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'",} 1.1602304E7
+jvm_memory_used_bytes{area="nonheap",id="Compressed Class Space",} 4273752.0
+jvm_memory_used_bytes{area="heap",id="G1 Eden Space",} 1.38412032E8
+jvm_memory_used_bytes{area="heap",id="G1 Old Gen",} 7638112.0
+jvm_memory_used_bytes{area="heap",id="G1 Survivor Space",} 7340032.0
+jvm_memory_used_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'",} 4083712.0
+jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-nmethods'",} 2555904.0
+jvm_memory_committed_bytes{area="nonheap",id="Metaspace",} 3.7486592E7
+jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'profiled nmethods'",} 1.1730944E7
+jvm_memory_committed_bytes{area="nonheap",id="Compressed Class Space",} 4587520.0
+jvm_memory_committed_bytes{area="heap",id="G1 Eden Space",} 1.58334976E8
+jvm_memory_committed_bytes{area="heap",id="G1 Old Gen",} 9.8566144E7
+jvm_memory_committed_bytes{area="heap",id="G1 Survivor Space",} 7340032.0
+jvm_memory_committed_bytes{area="nonheap",id="CodeHeap 'non-profiled nmethods'",} 4128768.0
+jvm_gc_memory_allocated_bytes_total 1.235222528E9
+hvves_connections_total 12.0
+jvm_classes_loaded 7120.0
+hvves_messages_sent_total 20000.0
+hvves_connections_active 1.0
+jvm_gc_live_data_size_bytes 7634496.0
+hvves_messages_latency_seconds_max 1.5459828692292638E9
+hvves_messages_latency_seconds_count 20000.0
+hvves_messages_latency_seconds_sum 2.91400110035487E9
\ No newline at end of file