Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: add PodMonitor configuration for Prometheus Operator #32

Merged
merged 3 commits into from
Oct 20, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions charts/helmet/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ name: helmet
description: Helmet is a library Helm Chart for grouping common logics. This chart is not deployable by itself.
home: https://github.com/companyinfo/helm-charts/blob/main/charts/helmet
type: library
version: "0.10.1"
appVersion: "0.10.1"
version: "0.10.2"
appVersion: "0.10.2"
alizdavoodi marked this conversation as resolved.
Show resolved Hide resolved
keywords:
- common
- helper
Expand Down
18 changes: 18 additions & 0 deletions charts/helmet/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,24 @@ $ helm install nginx .
| `serviceMonitor.port` | The port used by ServiceMonitor | `http` |
| `serviceMonitor.path` | The path used by ServiceMonitor | `metrics` |

### Prometheus Operator PodMonitor parameters

| Name | Description | Value |
|------------------------------------|-------------------------------------------------------------------------------------------------|-----------|
| `podMonitor.enabled` | Specify if a PodMonitor will be deployed for Prometheus Operator | `false` |
| `podMonitor.namespace` | Namespace in which Prometheus is running | `""` |
| `podMonitor.labels` | Additional PodMonitor labels (evaluated as a template) | `{}` |
| `podMonitor.annotations` | Additional PodMonitor annotations (evaluated as a template) | `{}` |
| `podMonitor.jobLabel` | The name of the label on the target service to use as the job name in Prometheus | `""` |
| `podMonitor.honorLabels` | The honorLabels chooses the metric's labels on collisions with target labels | `false` |
| `podMonitor.interval` | How frequently to scrape metrics | `""` |
| `podMonitor.scrapeTimeout` | Timeout after which the scrape is ended | `""` |
| `podMonitor.metricRelabelings` | Specify additional relabeling of metrics | `[]` |
| `podMonitor.relabelings` | Specify general relabeling | `[]` |
| `podMonitor.selector` | Prometheus instance selector labels | `{}` |
| `podMonitor.namespaceSelector` | The namespaceSelector is a selector for selecting either all namespaces or a list of namespaces | `{}` |
| `podMonitor.port` | The port used by PodMonitor | `http` |
| `podMonitor.path` | The path used by PodMonitor | `metrics` |

### ServiceAccount parameters

Expand Down
1 change: 1 addition & 0 deletions charts/helmet/templates/_app.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -23,4 +23,5 @@

{{ include "helmet.serviceaccount" . }}
{{ include "helmet.servicemonitor" . }}
{{ include "helmet.podmonitor" . }}
{{- end }}
58 changes: 58 additions & 0 deletions charts/helmet/templates/_podmonitor.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
{{- define "helmet.podmonitor" -}}
{{- if .Values.podMonitor.enabled }}
---
apiVersion: monitoring.coreos.com/v1
kind: PodMonitor
metadata:
name: {{ include "common.names.fullname" . }}
{{- if .Values.podMonitor.namespace }}
namespace: {{ .Values.podMonitor.namespace | quote }}
{{- else }}
namespace: {{ include "common.names.namespace" . | quote }}
{{- end }}
labels: {{- include "common.labels.standard" . | nindent 4 }}
{{- if .Values.podMonitor.labels }}
{{- include "common.tplvalues.render" (dict "value" .Values.podMonitor.labels "context" $) | nindent 4 }}
{{- end }}
{{- if .Values.commonLabels }}
{{- include "common.tplvalues.render" ( dict "value" .Values.commonLabels "context" $ ) | nindent 4 }}
{{- end }}
{{- if .Values.commonAnnotations }}
annotations: {{- include "common.tplvalues.render" ( dict "value" .Values.commonAnnotations "context" $ ) | nindent 4 }}
{{- end }}
spec:
{{- if .Values.podMonitor.jobLabel }}
jobLabel: {{ .Values.podMonitor.jobLabel }}
{{- end }}
podMetricsEndpoints:
- port: {{ .Values.podMonitor.port | quote }}
path: {{ .Values.podMonitor.path | quote }}
{{- if .Values.podMonitor.interval }}
interval: {{ .Values.podMonitor.interval }}
{{- end }}
{{- if .Values.podMonitor.scrapeTimeout }}
scrapeTimeout: {{ .Values.podMonitor.scrapeTimeout }}
{{- end }}
{{- if .Values.podMonitor.relabelings }}
relabelings: {{- include "common.tplvalues.render" ( dict "value" .Values.podMonitor.relabelings "context" $) | nindent 6 }}
{{- end }}
{{- if .Values.podMonitor.metricRelabelings }}
metricRelabelings: {{- include "common.tplvalues.render" ( dict "value" .Values.podMonitor.metricRelabelings "context" $) | nindent 6 }}
{{- end }}
{{- if .Values.podMonitor.honorLabels }}
honorLabels: {{ .Values.podMonitor.honorLabels }}
{{- end }}
namespaceSelector:
{{- if .Values.podMonitor.namespaceSelector }}
{{- include "common.tplvalues.render" (dict "value" .Values.podMonitor.namespaceSelector "context" $) | indent 4 }}
{{- else }}
matchNames:
- {{ include "common.names.namespace" . | quote }}
{{- end }}
selector:
matchLabels: {{ include "common.labels.matchLabels" . | nindent 6 }}
{{- if .Values.podMonitor.selector }}
{{- include "common.tplvalues.render" (dict "value" .Values.podMonitor.selector "context" $) | nindent 6 }}
{{- end }}
{{- end }}
{{- end -}}
50 changes: 50 additions & 0 deletions charts/helmet/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -720,6 +720,56 @@ exports:
##
path: "/metrics"

## Prometheus Operator PodMonitor configuration
##
podMonitor:
## @param podMonitor.enabled - Whether or not the PodMonitor should be created.
##
enabled: false

## @param podMonitor.namespace Namespace in which Prometheus is running
##
namespace: ""

## @param podMonitor.jobLabel Namespace in which Prometheus is running
##
jobLabel: ""

#@param podMonitor.port The port where metrics should be scraped.
port: "http"

## @param podMonitor.path The path where metrics are exposed.
##
path: "/metrics"

## @param podMonitor.interval Scrape interval. Prometheus default used if not set.
##
interval: "30s"

## @param podMonitor.scrapeTimeout The timeout duration after which the scrape is ended.
##
scrapeTimeout: "10s"

## @param podMonitor.labels Additional PodMonitor labels (evaluated as a template)
##
labels: {}

## @param podMonitor.relabelings [array] Specify general relabeling
##
relabelings: {}

## @param podMonitor.metricRelabelings [array] Specify additional relabeling of metrics
##
metricRelabelings: []

## @param podMonitor.namespaceSelector is a selector for selecting either all namespaces or a list of namespaces.
##
namespaceSelector: {}

## @param podMonitor.selector is a selector to select which pods will be monitored.
##
selector: {}

## Service account for APP pods to use.
## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
##
Expand Down