sidekiq-prometheus-exporter 0.1.10 → 0.1.15

data/helm/sidekiq-prometheus-exporter/templates/NOTES.txt

@@ -0,0 +1,15 @@
+Try out an exporter metrics:
+{{- if contains "NodePort" .Values.service.type }}
+  export NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "sidekiq-prometheus-exporter.fullname" . }})
+  export NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
+  echo "Run the following command: curl http://$NODE_IP:$NODE_PORT/metrics"
+{{- else if contains "LoadBalancer" .Values.service.type }}
+     NOTE: It may take a few minutes for the LoadBalancer IP to be available.
+           You can watch the status of by running 'kubectl get --namespace {{ .Release.Namespace }} svc -w {{ include "sidekiq-prometheus-exporter.fullname" . }}'
+  export SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "sidekiq-prometheus-exporter.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
+  echo "Run the following command: curl http://$SERVICE_IP:{{ .Values.service.port }}/metrics"
+{{- else if contains "ClusterIP" .Values.service.type }}
+  export POD_NAME=$(kubectl get pods --namespace {{ .Release.Namespace }} -l "app.kubernetes.io/name={{ include "sidekiq-prometheus-exporter.name" . }},app.kubernetes.io/instance={{ .Release.Name }}" -o jsonpath="{.items[0].metadata.name}")
+  kubectl port-forward $POD_NAME 9292:{{ .Values.containerPort  }}
+  echo "Run the following command: curl http://127.0.0.1:9292/metrics"
+{{- end }}

data/helm/sidekiq-prometheus-exporter/templates/_helpers.tpl

@@ -0,0 +1,109 @@
+{{/* vim: set filetype=mustache: */}}
+{{/*
+Expand the name of the chart.
+*/}}
+{{- define "sidekiq-prometheus-exporter.name" -}}
+{{- default .Chart.Name .Values.nameOverride | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Expand the name of the docker image.
+*/}}
+{{- define "sidekiq-prometheus-exporter.image" -}}
+{{- $registryName := .Values.image.registry -}}
+{{- $repositoryName := .Values.image.repository -}}
+{{- $tag := .Values.image.tag | toString -}}
+{{- printf "%s/%s:%s" $registryName $repositoryName $tag -}}
+{{- end -}}
+
+{{/*
+Create a default fully qualified app name.
+We truncate at 63 chars because some Kubernetes name fields are limited to this (by the DNS naming spec).
+If release name contains chart name it will be used as a full name.
+*/}}
+{{- define "sidekiq-prometheus-exporter.fullname" -}}
+{{- if .Values.fullnameOverride -}}
+{{- .Values.fullnameOverride | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- $name := default .Chart.Name .Values.nameOverride -}}
+{{- if contains $name .Release.Name -}}
+{{- .Release.Name | trunc 63 | trimSuffix "-" -}}
+{{- else -}}
+{{- printf "%s-%s" .Release.Name $name | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create chart name and version as used by the chart label.
+*/}}
+{{- define "sidekiq-prometheus-exporter.chart" -}}
+{{- printf "%s-%s" .Chart.Name .Chart.Version | replace "+" "_" | trunc 63 | trimSuffix "-" -}}
+{{- end -}}
+
+{{/*
+Create the name of the service account to use.
+*/}}
+{{- define "sidekiq-prometheus-exporter.serviceAccountName" -}}
+{{- if .Values.serviceAccount.create -}}
+{{ default (include "sidekiq-prometheus-exporter.fullname" .) .Values.serviceAccount.name }}
+{{- else -}}
+{{ default "default" .Values.serviceAccount.name }}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create pod service account name.
+*/}}
+{{- define "sidekiq-prometheus-exporter.podServiceAccountName" -}}
+{{- if and .Values.serviceAccount .Values.serviceAccount.create -}}
+serviceAccountName: {{ include "sidekiq-prometheus-exporter.serviceAccountName" . }}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create pod image pull secrets.
+*/}}
+{{- define "sidekiq-prometheus-exporter.podImagePullSecrets" -}}
+{{- if .Values.image.pullSecrets -}}
+imagePullSecrets:
+{{- range .Values.image.pullSecrets }}
+  - name: {{ . }}
+{{- end }}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Create container environment variables.
+*/}}
+{{- define "sidekiq-prometheus-exporter.env" -}}
+{{- if .Values.envFrom -}}
+envFrom:
+  {{ if eq (default "configMapRef" .Values.envFrom.type) "secretRef" -}}
+  - secretRef:
+      name: {{ .Values.envFrom.name }}
+  {{- else -}}
+  - configMapRef:
+      name: {{ .Values.envFrom.name }}
+  {{- end -}}
+{{- else if .Values.env -}}
+env:
+  {{- range $name, $value := .Values.env }}
+  - name: {{ $name }}
+    value: {{ $value | quote }}
+  {{- end }}
+{{- end -}}
+{{- end -}}
+
+{{/*
+Expand common labels.
+*/}}
+{{- define "sidekiq-prometheus-exporter.labels" -}}
+app.kubernetes.io/name: {{ include "sidekiq-prometheus-exporter.name" . }}
+helm.sh/chart: {{ include "sidekiq-prometheus-exporter.chart" . }}
+app.kubernetes.io/instance: {{ .Release.Name }}
+{{- if .Chart.AppVersion }}
+app.kubernetes.io/version: {{ .Chart.AppVersion | quote }}
+{{- end }}
+app.kubernetes.io/managed-by: {{ .Release.Service }}
+{{- end -}}

data/helm/sidekiq-prometheus-exporter/templates/clusterrole.yaml

@@ -0,0 +1,20 @@
+{{- if and .Values.rbac.create }}
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRole
+metadata:
+  name: {{ template "sidekiq-prometheus-exporter.fullname" . }}
+  labels:
+    {{- include "sidekiq-prometheus-exporter.labels" . | nindent 4 }}
+rules:
+  - apiGroups: [""]
+    resources:
+    {{- if eq (default "configMapRef" .Values.envFrom.type) "secretRef" }}
+      - "secrets"
+    {{- else }}
+      - "configmap"
+    {{- end }}
+    resourceNames:
+      - {{ .Values.envFrom.name | quote }}
+    verbs: ["get"]
+{{- end }}

data/helm/sidekiq-prometheus-exporter/templates/clusterrolebinding.yaml

@@ -0,0 +1,17 @@
+{{- if and .Values.rbac.create }}
+---
+apiVersion: rbac.authorization.k8s.io/v1
+kind: ClusterRoleBinding
+metadata:
+  name: {{ template "sidekiq-prometheus-exporter.fullname" . }}
+  labels:
+    {{- include "sidekiq-prometheus-exporter.labels" . | nindent 4 }}
+subjects:
+  - kind: ServiceAccount
+    name: {{ include "sidekiq-prometheus-exporter.serviceAccountName" . }}
+    namespace: {{ .Release.Namespace }}
+roleRef:
+  kind: ClusterRole
+  name: {{ template "sidekiq-prometheus-exporter.fullname" . }}
+  apiGroup: rbac.authorization.k8s.io
+{{- end }}

data/helm/sidekiq-prometheus-exporter/templates/deployment.yaml

@@ -0,0 +1,62 @@
+---
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: {{ include "sidekiq-prometheus-exporter.fullname" . }}
+  labels:
+    {{- include "sidekiq-prometheus-exporter.labels" . | nindent 4 }}
+spec:
+  replicas: 1
+  selector:
+    matchLabels:
+      app.kubernetes.io/name: {{ include "sidekiq-prometheus-exporter.name" . }}
+      app.kubernetes.io/instance: {{ .Release.Name }}
+  template:
+    metadata:
+      labels:
+        app.kubernetes.io/name: {{ include "sidekiq-prometheus-exporter.name" . }}
+        app.kubernetes.io/instance: {{ .Release.Name }}
+      {{- with .Values.podAnnotations }}
+      annotations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+    spec:
+      containers:
+        - name: {{ .Chart.Name }}
+          image: {{ include "sidekiq-prometheus-exporter.image" . }}
+          imagePullPolicy: {{ .Values.image.pullPolicy }}
+          ports:
+            - name: metrics
+              containerPort: {{ .Values.containerPort }}
+              protocol: TCP
+          {{- with  .Values.resources }}
+          resources:
+            {{- toYaml . | nindent 12 }}
+          {{- end }}
+          livenessProbe:
+            tcpSocket:
+              port: metrics
+              {{- toYaml .Values.livenessProbe | nindent 12 }}
+          readinessProbe:
+            tcpSocket:
+              port: metrics
+              {{- toYaml .Values.readinessProbe | nindent 12 }}
+          {{- include "sidekiq-prometheus-exporter.env" . | nindent 10 }}
+      {{- with .Values.nodeSelector }}
+      nodeSelector:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.affinity }}
+      affinity:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.tolerations }}
+      tolerations:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- with .Values.securityContext }}
+      securityContext:
+        {{- toYaml . | nindent 8 }}
+      {{- end }}
+      {{- include "sidekiq-prometheus-exporter.podServiceAccountName" . | nindent 6 }}
+      {{- include "sidekiq-prometheus-exporter.podImagePullSecrets" . | nindent 6 }}

data/helm/sidekiq-prometheus-exporter/templates/service.yaml

@@ -0,0 +1,17 @@
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: {{ include "sidekiq-prometheus-exporter.fullname" . }}
+  labels:
+    {{- include "sidekiq-prometheus-exporter.labels" . | nindent 4 }}
+spec:
+  type: {{ .Values.service.type }}
+  ports:
+    - port: {{ .Values.service.port }}
+      targetPort: metrics
+      protocol: TCP
+      name: metrics
+  selector:
+    app.kubernetes.io/name: {{ include "sidekiq-prometheus-exporter.name" . }}
+    app.kubernetes.io/instance: {{ .Release.Name }}

data/helm/sidekiq-prometheus-exporter/templates/serviceaccount.yaml

@@ -0,0 +1,9 @@
+{{- if .Values.serviceAccount.create }}
+---
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: {{ template "sidekiq-prometheus-exporter.fullname" . }}
+  labels:
+    {{- include "sidekiq-prometheus-exporter.labels" . | nindent 4 }}
+{{- end }}

data/helm/sidekiq-prometheus-exporter/templates/servicemonitor.yaml

@@ -0,0 +1,26 @@
+{{- if .Values.serviceMonitor.enabled }}
+---
+apiVersion: monitoring.coreos.com/v1
+kind: ServiceMonitor
+metadata:
+  name: {{ template "sidekiq-prometheus-exporter.fullname" . }}
+  namespace: {{ .Release.Namespace | quote }}
+  labels:
+    {{- include "sidekiq-prometheus-exporter.labels" . | nindent 4 }}
+    {{- with .Values.serviceMonitor.labels }}
+      {{- toYaml . | nindent 4 }}
+    {{- end }}
+spec:
+  jobLabel: {{ template "sidekiq-prometheus-exporter.fullname" . }}
+  selector:
+    matchLabels:
+      {{- include "sidekiq-prometheus-exporter.labels" . | nindent 6 }}
+  namespaceSelector:
+    matchNames:
+      - {{ .Release.Namespace | quote }}
+  endpoints:
+  - port: metrics
+    path: {{ .Values.serviceMonitor.path }}
+    interval: {{ .Values.serviceMonitor.interval }}
+    scrapeTimeout: {{ .Values.serviceMonitor.scrapeTimeout }}
+{{- end }}

data/helm/sidekiq-prometheus-exporter/values.yaml

@@ -0,0 +1,134 @@
+---
+## Default values for sidekiq-prometheus-exporter.
+## This is a YAML-formatted file.
+## Declare variables to be passed into your templates.
+
+## Official docker image version
+## ref: https://hub.docker.com/r/strech/sidekiq-prometheus-exporter/tags/
+##
+image:
+  registry: docker.io
+  repository: strech/sidekiq-prometheus-exporter
+  tag: 0.1.15
+  ## Specify a imagePullPolicy
+  ## Defaults to 'Always' if image tag is 'latest', else set to 'IfNotPresent'
+  ## ref: http://kubernetes.io/docs/user-guide/images/#pre-pulling-images
+  ##
+  pullPolicy: IfNotPresent
+  ## Optionally specify an array of imagePullSecrets.
+  ## Secrets must be manually created in the namespace.
+  ## ref: https://kubernetes.io/docs/tasks/configure-pod-container/pull-image-private-registry/
+  ##
+  # pullSecrets:
+  #   - myRegistryKeySecretName
+
+## String to partially override Values.fullname template (will maintain the release name)
+##
+# nameOverride:
+
+## String to fully override Values.fullname template
+##
+# fullnameOverride:
+
+## Metrics exporter resource requests and limits
+## ref: http://kubernetes.io/docs/user-guide/compute-resources/
+##
+# resources:
+#   limits:
+#     cpu: 100m
+#     memory: 128Mi
+#   requests:
+#     cpu: 100m
+#     memory: 128Mi
+
+## Metrics exporter selectors and tolerations for pod assignment
+## ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#nodeselector
+## ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#taints-and-tolerations-beta-feature
+##
+# nodeSelector:
+# tolerations:
+
+## Metrics exporter pod/node affinity/anti-affinity
+## ref: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/#affinity-and-anti-affinity
+##
+# affinity:
+
+## Metrics exporter liveness and readiness probes
+## ref: https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-startup-probes/
+##
+livenessProbe:
+  initialDelaySeconds: 5
+  periodSeconds: 5
+  timeoutSeconds: 5
+  successThreshold: 1
+  failureThreshold: 3
+readinessProbe:
+  initialDelaySeconds: 5
+  periodSeconds: 5
+  timeoutSeconds: 5
+  successThreshold: 1
+  failureThreshold: 3
+
+## Metrics exporter container port
+##
+containerPort: 9292
+
+## Metrics exporter container Environment Variables
+## ref: https://github.com/Strech/sidekiq-prometheus-exporter/tree/master/docker#supported-envs
+##
+# env:
+#   REDIS_HOST: "localhost"
+#   REDIS_PORT: 6379
+#   REDIS_URL: "..."
+#   REDIS_PASSWORD: "..."
+#   REDIS_DB_NUMBER: "0"
+#   REDIS_NAMESPACE: "..."
+#   REDIS_SENTINELS: "..."
+#   REDIS_SENTINEL_ROLE: "..."
+#   REDIS_DISABLE_CLIENT_ID: "false"
+# envFrom:
+#   type: configMapRef
+#   name: myConfigMapReference
+
+## Metrics exporter Security Context
+## ref: https://kubernetes.io/docs/tasks/configure-pod-container/security-context
+##
+# securityContext:
+#   runAsUser: 65534
+
+## Metrics exporter pod Annotations
+##
+# podAnnotations:
+
+## Metrics exporter Service properties
+##
+service:
+  ## Metrics exporter Service type
+  ##
+  type: ClusterIP
+  port: 80
+
+serviceAccount:
+  ## Specifies whether a ServiceAccount should be created
+  ##
+  create: true
+  ## The name of the ServiceAccount to use.
+  ## If not set and create is true, a name is generated using the fullname template
+  ##
+  # name:
+
+rbac:
+  ## Specifies whether RBAC resources should be created
+  ##
+  create: false
+
+## Enable this if you're using https://github.com/coreos/prometheus-operator
+##
+serviceMonitor:
+  enabled: false
+  path: "/metrics"
+  interval: 1m
+  scrapeTimeout: 10s
+  ## Additional labels for the Service Monitor
+  ##
+  # labels:

data/lib/sidekiq/prometheus/exporter.rb

@@ -11,10 +11,21 @@ module Sidekiq
       REQUEST_METHOD = 'REQUEST_METHOD'.freeze
       NOT_FOUND_TEXT = 'Not Found'.freeze
       MOUNT_PATH = '/metrics'.freeze
-      HEADERS = {'Content-Type' => 'text/plain; version=0.0.4', 'Cache-Control' => 'no-cache'}.freeze
+      # rubocop:disable Style/MutableConstant
+      HEADERS = {'Content-Type' => 'text/plain; version=0.0.4', 'Cache-Control' => 'no-cache'}
+      # rubocop:enable Style/MutableConstant
       EXPORTERS = Exporters.new
 
       class << self
+        def banner
+          exporters =
+            EXPORTERS.enabled
+              .map { |klass| "  - #{klass.name.split('::').last.downcase}" }
+              .join("\n".freeze)
+
+          "Enabled Sidekiq Prometheus exporters:\n#{exporters}"
+        end
+
         def configure
           yield(EXPORTERS)
         end