summaryrefslogtreecommitdiffstats
path: root/docs/development/design/monitoring.rst
diff options
context:
space:
mode:
authorYujun Zhang <zhang.yujunz@zte.com.cn>2018-04-03 16:48:24 +0800
committerYujun Zhang <zhang.yujunz@zte.com.cn>2018-04-04 09:05:06 +0800
commitc8a6fe5bb4233eb0551b8424f5d57121e86124a1 (patch)
treee20b2d5586b9b1da5afdd2e90f0dfc83bf3b00b5 /docs/development/design/monitoring.rst
parent67b7fb49e6ea6ac9c2547af263355e5f1aeade42 (diff)
Move design document to dedicated folder
Change-Id: I20c85b7116cd2b29d0efcaae5ee0b0381a685bbb Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>
Diffstat (limited to 'docs/development/design/monitoring.rst')
-rw-r--r--docs/development/design/monitoring.rst31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/development/design/monitoring.rst b/docs/development/design/monitoring.rst
new file mode 100644
index 0000000..44b01e3
--- /dev/null
+++ b/docs/development/design/monitoring.rst
@@ -0,0 +1,31 @@
+##########
+Monitoring
+##########
+
+************
+Installation
+************
+
+Currently, we use the Istio build-in prometheus addon to install prometheus::
+
+ cd <istio-release-path>
+ kubectl apply -f install/kubernetes/addons/prometheus.yaml
+
+********
+Validate
+********
+
+Setup port-forwarding for prometheus by executing the following command::
+
+ kubectl -n istio-system port-forward $(kubectl -n istio-system get pod -l app=prometheus -o jsonpath='{.items[0].metadata.name}') 9090:9090 &
+
+Run the scripts in ``clover/monitoring`` validates prometheus installation::
+
+ python clover/monitoring/validate.py
+
+It validates the installation with the following criterias
+
+#. [DONE] prometheus pod is in Running state
+#. [DONE] prometheus is conneted to monitoring targets
+#. [TODO] test collecting telemetry data from istio
+#. [TODO] TBD