feat: Add serviceMonitor resource (opensearch-project#537)

* feat: Add serviceMonitor resource Signed-off-by: Shubham Gupta <[email protected]> Signed-off-by: VILJkid <[email protected]> * fix: metrics path Signed-off-by: Shubham Gupta <[email protected]> Signed-off-by: VILJkid <[email protected]> * (lint) : trailing newline Signed-off-by: VILJkid <[email protected]> * (update) : readme and changelog with comments Signed-off-by: VILJkid <[email protected]> * (add) : opensearch-dashboard for serviceMonitor Signed-off-by: VILJkid <[email protected]> * (chore) : bump changelog version Signed-off-by: VILJkid <[email protected]> * (chore) : bump version Signed-off-by: VILJkid <[email protected]> * (lint) : add newline Signed-off-by: VILJkid <[email protected]> * (fix) : changelog compare versions Signed-off-by: VILJkid <[email protected]> * (fix) : bump minor versions instead of patch Signed-off-by: VILJkid <[email protected]> --------- Signed-off-by: Shubham Gupta <[email protected]> Signed-off-by: VILJkid <[email protected]> Co-authored-by: Shubham Gupta <[email protected]> Co-authored-by: VILJkid <[email protected]>
Obmondo · Aug 22, 2024 · 4253842 · 4253842
1 parent 4ca8bfd
commit 4253842
Show file tree

Hide file tree

Showing 10 changed files with 310 additions and 180 deletions.
diff --git a/charts/opensearch-dashboards/CHANGELOG.md b/charts/opensearch-dashboards/CHANGELOG.md
@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -13,6 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 ---
+## [2.21.0]
+### Added
+- Added `ServiceMonitor` support for Prometheus monitoring
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+---
 ## [2.20.0]
 ### Added
 - Updated OpenSearch Dashboards appVersion to 2.16.0
@@ -358,7 +368,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 
-[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-2.20.0...HEAD
+[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-2.21.0...HEAD
+[2.21.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-2.20.0...opensearch-dashboards-2.21.0
 [2.20.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-2.19.1...opensearch-dashboards-2.20.0
 [2.19.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-2.19.0...opensearch-dashboards-2.19.1
 [2.19.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-dashboards-2.18.0...opensearch-dashboards-2.19.0

diff --git a/charts/opensearch-dashboards/Chart.yaml b/charts/opensearch-dashboards/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 2.20.0
+version: 2.21.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

diff --git a/charts/opensearch-dashboards/README.md b/charts/opensearch-dashboards/README.md
diff --git a/charts/opensearch-dashboards/templates/serviceMonitor.yaml b/charts/opensearch-dashboards/templates/serviceMonitor.yaml
@@ -0,0 +1,17 @@
+{{- if .Values.serviceMonitor.enabled }}
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ template "opensearch-dashboards.fullname" . }}-service-monitor
+  namespace: {{ .Release.Namespace }}
+  labels:
+    {{- include "opensearch-dashboards.labels" . | nindent 4 }}
+spec:
+  selector:
+    matchLabels:
+      {{- include "opensearch-dashboards.selectorLabels" . | nindent 6 }}
+  endpoints:
+  - port: {{ .Values.metricsPort }}
+    interval: {{ .Values.serviceMonitor.interval }}
+    path: {{ .Values.serviceMonitor.path }}
+{{- end }}
diff --git a/charts/opensearch-dashboards/values.yaml b/charts/opensearch-dashboards/values.yaml
@@ -276,3 +276,21 @@ plugins:
   enabled: false
   installList: []
   # - example-fake-plugin-downloadable-url
+
+# ServiceMonitor Configuration for Prometheus
+# Enabling this option will create a ServiceMonitor resource that allows Prometheus to scrape metrics from the OpenSearch service.
+serviceMonitor:
+  # Set to true to enable the ServiceMonitor resource for OpenSearch Dashboards
+  enabled: false
+
+  # HTTP path where metrics are exposed by OpenSearch Dashboards.
+  # Ensure this path is correctly set in your service.
+  path: /_prometheus/metrics
+
+  # Frequency at which Prometheus will scrape metrics.
+  # Modify as needed for your monitoring requirements.
+  interval: 10s
+
+# Port configuration for metrics.
+# This should match the port exposed by the OpenSearch Dashboards service.
+metricsPort: 9601
diff --git a/charts/opensearch/CHANGELOG.md b/charts/opensearch/CHANGELOG.md
@@ -1,4 +1,5 @@
 # Changelog
+
 All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
@@ -13,6 +14,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fixed
 ### Security
 ---
+## [2.23.0]
+### Added
+- Added `ServiceMonitor` support for Prometheus monitoring
+### Changed
+### Deprecated
+### Removed
+### Fixed
+### Security
+---
 ## [2.22.1]
 ### Added
 ### Changed
@@ -440,7 +450,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Security
 
 
-[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.22.1...HEAD
+[Unreleased]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.23.0...HEAD
+[2.23.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.22.1...opensearch-2.23.0
 [2.22.1]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.22.0...opensearch-2.22.1
 [2.22.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.21.0...opensearch-2.22.0
 [2.21.0]: https://github.com/opensearch-project/helm-charts/compare/opensearch-2.20.0...opensearch-2.21.0

diff --git a/charts/opensearch/Chart.yaml b/charts/opensearch/Chart.yaml
@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 2.22.1
+version: 2.23.0
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to