From: mpriyank <priyank.maheshwari@est.tech>
Date: Thu, 23 Jan 2025 14:35:52 +0000 (+0000)
Subject: RTD supporting heapdump and threaddump exposure
X-Git-Tag: 3.6.0~9
X-Git-Url: https://gerrit.onap.org/r/gitweb?a=commitdiff_plain;h=2bad07dc5d0c7e00d7fe609e5e40346d77c6889a;p=cps.git

RTD supporting heapdump and threaddump exposure

- actuator endpoint now have support for heapdump via /actuator/heapdump
  and the dump will be downloaded on the machine
- threaddump is available on /actuator/threddump and will be available
  as response text

Issue-ID: CPS-2453
Change-Id: I263b39478bb953c70b2ffca09760c18d7e50da91
Signed-off-by: mpriyank <priyank.maheshwari@est.tech>
---

diff --git a/docs/admin-guide.rst b/docs/admin-guide.rst
index 68edc87c81..7e71a07e23 100644
--- a/docs/admin-guide.rst
+++ b/docs/admin-guide.rst
@@ -226,6 +226,16 @@ Prometheus Metrics can be checked at the following endpoint
 
     http://<cps-component-service-name>:8080/actuator/prometheus
 
+Heap Dump and Thread Dump
+-------------------------
+
+On demand heap dump and thread dump generation using the below endpoints.
+
+.. code::
+
+    http://<cps-component-service-name>:8080/actuator/heapdump
+    http://<cps-component-service-name>:8080/actuator/threaddump
+
 Hazelcast
 ---------