summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/heartbeat-ms/index.rst
diff options
context:
space:
mode:
authorPrakashH <pbhandar@techmahindra.com>2019-01-22 08:19:43 +0000
committerPrakashH <pbhandar@techmahindra.com>2019-01-22 08:19:43 +0000
commit3bcb00f79c6bacc5c1ed3c3c2fd7642992707f23 (patch)
treeb33ec120837287faa54b8bacbee64de8ae21fcc8 /docs/sections/services/heartbeat-ms/index.rst
parent6c93a7444773177d9bad86e720ba7966061973df (diff)
Heartbeat Microservice User Documentation
User Documentation for heartbeat Microservice Issue-ID: DCAEGEN2-280 Change-Id: I158680b11b5d5de4a0d58f4d2f03816e2b1941fc Signed-off-by: PrakashH <pbhandar@techmahindra.com>
Diffstat (limited to 'docs/sections/services/heartbeat-ms/index.rst')
-rw-r--r--docs/sections/services/heartbeat-ms/index.rst24
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/sections/services/heartbeat-ms/index.rst b/docs/sections/services/heartbeat-ms/index.rst
new file mode 100644
index 00000000..4b67e98f
--- /dev/null
+++ b/docs/sections/services/heartbeat-ms/index.rst
@@ -0,0 +1,24 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Heartbeat Microservice (version 2.1.0)
+======================================
+
+The main objective of **Heartbeat Microservice** is to receive the periodic
+heartbeat from the configured eventNames and report the loss of heartbeat
+onto DMaap if number of consecutive missed heartbeat count is more than
+the configured missed heartbeat count
+
+Heartbeat Microservice overview and functions
+---------------------------------------------
+
+.. toctree::
+ :maxdepth: 1
+
+ architecture
+ design
+ build_setup
+ testprocedure
+
+
+