Add ServiceMonitors for rest of OPEA applications (#524)

Signed-off-by: Eero Tamminen <[email protected]>
opea-project · Nov 6, 2024 · fc6235a · fc6235a
1 parent c476fde
commit fc6235a
Show file tree

Hide file tree

Showing 17 changed files with 169 additions and 26 deletions.
diff --git a/helm-charts/audioqna/README.md b/helm-charts/audioqna/README.md
@@ -53,8 +53,9 @@ curl http://localhost:3008/v1/audioqna \
 
 ## Values
 
-| Key              | Type   | Default                     | Description                                                              |
-| ---------------- | ------ | --------------------------- | ------------------------------------------------------------------------ |
-| image.repository | string | `"opea/audioqna"`           |                                                                          |
-| service.port     | string | `"3008"`                    |                                                                          |
-| tgi.LLM_MODEL_ID | string | `Intel/neural-chat-7b-v3-3` | Models id from https://huggingface.co/, or predownloaded model directory |
+| Key               | Type   | Default                     | Description                                                                            |
+| ----------------- | ------ | --------------------------- | -------------------------------------------------------------------------------------- |
+| image.repository  | string | `"opea/audioqna"`           |                                                                                        |
+| service.port      | string | `"3008"`                    |                                                                                        |
+| tgi.LLM_MODEL_ID  | string | `Intel/neural-chat-7b-v3-3` | Models id from https://huggingface.co/, or predownloaded model directory               |
+| global.monitoring | bool   | `false`                     | Enable usage metrics for the service components. See ../monitoring.md before enabling! |
diff --git a/helm-charts/audioqna/templates/servicemonitor.yaml b/helm-charts/audioqna/templates/servicemonitor.yaml
@@ -0,0 +1,18 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+{{- if .Values.global.monitoring }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ include "audioqna.fullname" . }}
+  labels:
+    release: {{ .Values.global.prometheusRelease }}
+spec:
+  selector:
+    matchLabels:
+      {{- include "audioqna.selectorLabels" . | nindent 6 }}
+  endpoints:
+  - port: audioqna
+    interval: 5s
+{{- end }}
diff --git a/helm-charts/audioqna/values.yaml b/helm-charts/audioqna/values.yaml
@@ -60,3 +60,9 @@ global:
   modelUseHostPath: ""
   # modelUseHostPath: /mnt/opea-models
   # modelUsePVC: model-volume
+
+  # Install Prometheus serviceMonitors for service components
+  monitoring: false
+
+  # Prometheus Helm install release name needed for serviceMonitors
+  prometheusRelease: prometheus-stack
diff --git a/helm-charts/codegen/README.md b/helm-charts/codegen/README.md
@@ -56,8 +56,9 @@ Open a browser to access `http://<k8s-node-ip-address>:${port}` to play with the
 
 ## Values
 
-| Key              | Type   | Default                            | Description                                                              |
-| ---------------- | ------ | ---------------------------------- | ------------------------------------------------------------------------ |
-| image.repository | string | `"opea/codegen"`                   |                                                                          |
-| service.port     | string | `"7778"`                           |                                                                          |
-| tgi.LLM_MODEL_ID | string | `"Qwen/Qwen2.5-Coder-7B-Instruct"` | Models id from https://huggingface.co/, or predownloaded model directory |
+| Key               | Type   | Default                            | Description                                                                            |
+| ----------------- | ------ | ---------------------------------- | -------------------------------------------------------------------------------------- |
+| image.repository  | string | `"opea/codegen"`                   |                                                                                        |
+| service.port      | string | `"7778"`                           |                                                                                        |
+| tgi.LLM_MODEL_ID  | string | `"Qwen/Qwen2.5-Coder-7B-Instruct"` | Models id from https://huggingface.co/, or predownloaded model directory               |
+| global.monitoring | bool   | `false`                            | Enable usage metrics for the service components. See ../monitoring.md before enabling! |
diff --git a/helm-charts/codegen/templates/servicemonitor.yaml b/helm-charts/codegen/templates/servicemonitor.yaml
@@ -0,0 +1,18 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+{{- if .Values.global.monitoring }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ include "codegen.fullname" . }}
+  labels:
+    release: {{ .Values.global.prometheusRelease }}
+spec:
+  selector:
+    matchLabels:
+      {{- include "codegen.selectorLabels" . | nindent 6 }}
+  endpoints:
+  - port: codegen
+    interval: 5s
+{{- end }}
diff --git a/helm-charts/codegen/values.yaml b/helm-charts/codegen/values.yaml
@@ -59,3 +59,9 @@ global:
   modelUseHostPath: ""
   # modelUseHostPath: /mnt/opea-models
   # modelUsePVC: model-volume
+
+  # Install Prometheus serviceMonitors for service components
+  monitoring: false
+
+  # Prometheus Helm install release name needed for serviceMonitors
+  prometheusRelease: prometheus-stack
diff --git a/helm-charts/codetrans/README.md b/helm-charts/codetrans/README.md
@@ -57,8 +57,9 @@ Open a browser to access `http://<k8s-node-ip-address>:${port}` to play with the
 
 ## Values
 
-| Key              | Type   | Default                                | Description                                                              |
-| ---------------- | ------ | -------------------------------------- | ------------------------------------------------------------------------ |
-| image.repository | string | `"opea/codetrans"`                     |                                                                          |
-| service.port     | string | `"7777"`                               |                                                                          |
-| tgi.LLM_MODEL_ID | string | `"mistralai/Mistral-7B-Instruct-v0.3"` | Models id from https://huggingface.co/, or predownloaded model directory |
+| Key               | Type   | Default                                | Description                                                                            |
+| ----------------- | ------ | -------------------------------------- | -------------------------------------------------------------------------------------- |
+| image.repository  | string | `"opea/codetrans"`                     |                                                                                        |
+| service.port      | string | `"7777"`                               |                                                                                        |
+| tgi.LLM_MODEL_ID  | string | `"mistralai/Mistral-7B-Instruct-v0.3"` | Models id from https://huggingface.co/, or predownloaded model directory               |
+| global.monitoring | bool   | `false`                                | Enable usage metrics for the service components. See ../monitoring.md before enabling! |
diff --git a/helm-charts/codetrans/templates/servicemonitor.yaml b/helm-charts/codetrans/templates/servicemonitor.yaml
@@ -0,0 +1,18 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+{{- if .Values.global.monitoring }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ include "codetrans.fullname" . }}
+  labels:
+    release: {{ .Values.global.prometheusRelease }}
+spec:
+  selector:
+    matchLabels:
+      {{- include "codetrans.selectorLabels" . | nindent 6 }}
+  endpoints:
+  - port: codetrans
+    interval: 5s
+{{- end }}
diff --git a/helm-charts/codetrans/values.yaml b/helm-charts/codetrans/values.yaml
@@ -60,3 +60,9 @@ global:
   modelUseHostPath: ""
   # modelUseHostPath: /mnt/opea-models
   # modelUsePVC: model-volume
+
+  # Install Prometheus serviceMonitors for service components
+  monitoring: false
+
+  # Prometheus Helm install release name needed for serviceMonitors
+  prometheusRelease: prometheus-stack
diff --git a/helm-charts/docsum/README.md b/helm-charts/docsum/README.md
@@ -51,8 +51,9 @@ Open a browser to access `http://<k8s-node-ip-address>:${port}` to play with the
 
 ## Values
 
-| Key              | Type   | Default                       | Description                                                              |
-| ---------------- | ------ | ----------------------------- | ------------------------------------------------------------------------ |
-| image.repository | string | `"opea/docsum"`               |                                                                          |
-| service.port     | string | `"8888"`                      |                                                                          |
-| tgi.LLM_MODEL_ID | string | `"Intel/neural-chat-7b-v3-3"` | Models id from https://huggingface.co/, or predownloaded model directory |
+| Key               | Type   | Default                       | Description                                                                            |
+| ----------------- | ------ | ----------------------------- | -------------------------------------------------------------------------------------- |
+| image.repository  | string | `"opea/docsum"`               |                                                                                        |
+| service.port      | string | `"8888"`                      |                                                                                        |
+| tgi.LLM_MODEL_ID  | string | `"Intel/neural-chat-7b-v3-3"` | Models id from https://huggingface.co/, or predownloaded model directory               |
+| global.monitoring | bool   | `false`                       | Enable usage metrics for the service components. See ../monitoring.md before enabling! |
diff --git a/helm-charts/docsum/templates/servicemonitor.yaml b/helm-charts/docsum/templates/servicemonitor.yaml
@@ -0,0 +1,18 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+{{- if .Values.global.monitoring }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ include "docsum.fullname" . }}
+  labels:
+    release: {{ .Values.global.prometheusRelease }}
+spec:
+  selector:
+    matchLabels:
+      {{- include "docsum.selectorLabels" . | nindent 6 }}
+  endpoints:
+  - port: docsum
+    interval: 5s
+{{- end }}
diff --git a/helm-charts/docsum/values.yaml b/helm-charts/docsum/values.yaml
@@ -65,3 +65,9 @@ global:
   modelUseHostPath: ""
   # modelUseHostPath: /mnt/opea-models
   # modelUsePVC: model-volume
+
+  # Install Prometheus serviceMonitors for service components
+  monitoring: false
+
+  # Prometheus Helm install release name needed for serviceMonitors
+  prometheusRelease: prometheus-stack
diff --git a/helm-charts/faqgen/README.md b/helm-charts/faqgen/README.md
@@ -35,8 +35,9 @@ Open a browser to access `http://<k8s-node-ip-address>:${port}` to play with the
 
 ## Values
 
-| Key              | Type   | Default                                 | Description                                                              |
-| ---------------- | ------ | --------------------------------------- | ------------------------------------------------------------------------ |
-| image.repository | string | `"opea/faqgen"`                         |                                                                          |
-| service.port     | string | `"8888"`                                |                                                                          |
-| tgi.LLM_MODEL_ID | string | `"meta-llama/Meta-Llama-3-8B-Instruct"` | Models id from https://huggingface.co/, or predownloaded model directory |
+| Key               | Type   | Default                                 | Description                                                                            |
+| ----------------- | ------ | --------------------------------------- | -------------------------------------------------------------------------------------- |
+| image.repository  | string | `"opea/faqgen"`                         |                                                                                        |
+| service.port      | string | `"8888"`                                |                                                                                        |
+| tgi.LLM_MODEL_ID  | string | `"meta-llama/Meta-Llama-3-8B-Instruct"` | Models id from https://huggingface.co/, or predownloaded model directory               |
+| global.monitoring | bool   | `false`                                 | Enable usage metrics for the service components. See ../monitoring.md before enabling! |
diff --git a/helm-charts/faqgen/templates/servicemonitor.yaml b/helm-charts/faqgen/templates/servicemonitor.yaml
@@ -0,0 +1,18 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+{{- if .Values.global.monitoring }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ include "faqgen.fullname" . }}
+  labels:
+    release: {{ .Values.global.prometheusRelease }}
+spec:
+  selector:
+    matchLabels:
+      {{- include "faqgen.selectorLabels" . | nindent 6 }}
+  endpoints:
+  - port: faqgen
+    interval: 5s
+{{- end }}
diff --git a/helm-charts/faqgen/values.yaml b/helm-charts/faqgen/values.yaml
@@ -64,3 +64,9 @@ global:
   modelUseHostPath: ""
   # modelUseHostPath: /mnt/opea-models
   # modelUsePVC: model-volume
+
+  # Install Prometheus serviceMonitors for service components
+  monitoring: false
+
+  # Prometheus Helm install release name needed for serviceMonitors
+  prometheusRelease: prometheus-stack
diff --git a/helm-charts/visualqna/README.md b/helm-charts/visualqna/README.md
@@ -42,4 +42,4 @@ Open a browser to access `http://<k8s-node-ip-address>:${port}` to play with the
 | image.repository  | string | `"opea/visualqna"`                    |                                                                                        |
 | service.port      | string | `"8888"`                              |                                                                                        |
 | tgi.LLM_MODEL_ID  | string | `"llava-hf/llava-v1.6-mistral-7b-hf"` | Models id from https://huggingface.co/, or predownloaded model directory               |
-| global.monitoring | bop;   | false                                 | Enable usage metrics for the service components. See ../monitoring.md before enabling! |
+| global.monitoring | bool   | `false`                               | Enable usage metrics for the service components. See ../monitoring.md before enabling! |
diff --git a/helm-charts/visualqna/templates/servicemonitor.yaml b/helm-charts/visualqna/templates/servicemonitor.yaml
@@ -0,0 +1,18 @@
+# Copyright (C) 2024 Intel Corporation
+# SPDX-License-Identifier: Apache-2.0
+
+{{- if .Values.global.monitoring }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ include "visualqna.fullname" . }}
+  labels:
+    release: {{ .Values.global.prometheusRelease }}
+spec:
+  selector:
+    matchLabels:
+      {{- include "visualqna.selectorLabels" . | nindent 6 }}
+  endpoints:
+  - port: visualqna
+    interval: 5s
+{{- end }}