Merge pull request #20 from raffis/v1

allow custom metrics path #19

Author: raffis

CHANGELOG.md

@@ -1,3 +1,13 @@
+# 1.0.0-beta7
+**Date**: Mon Jan 18 21:34:20 CET 2020
+
+## Bugfixes
+* Fixes missing Path in ServiceMonitor helm chart
+
+## Features
+* Support changeable metrics path #19
+
+
 # 1.0.0-beta6
 **Date**: Thu Nov 12 22:35:21 CET 2020
 

README.md

@@ -65,7 +65,7 @@ mongodb://CN=myName,OU=myOrgUnit,O=myOrg,L=myLocality,ST=myState,C=myCountry@loc
 ```
 
 ## Access metrics
-The metrics are exposed at `/metrics`.
+The metrics are by default exposed at `/metrics`.
 
 ```
 curl localhost:9412/metrics
@@ -85,6 +85,7 @@ You may also use env variables to configure the exporter:
 | MDBEXPORTER_LOG_LEVEL    | Log level                                |
 | MDBEXPORTER_LOG_ENCODING | Log format                               |
 | MDBEXPORTER_BIND         | Bind address for the HTTP server         |
+| MDBEXPORTER_METRICSPATH  | Change the metrics path (/metrics)       |
 
 Note if you have multiple MongoDB servers you can inject an env variable for each instead using `MDBEXPORTER_MONGODB_URI`:
 

chart/prometheus-mongodb-query-exporter/Chart.yaml

@@ -1,6 +1,6 @@
 apiVersion: v2
-appVersion: 1.0.0-beta6
-description: A Prometheus exporter for MongoDB custom query/aggregations
+appVersion: 1.0.0-beta7
+description: A Prometheus exporter for MongoDB custom aggregations
 home: https://github.com/raffis/mongodb-query-exporter
 keywords:
 - exporter
@@ -12,4 +12,4 @@ keywords:
 name: prometheus-mongodb-query-exporter
 sources:
 - https://github.com/raffis/mongodb-query-exporter
-version: 1.0.3
+version: 1.1.3

chart/prometheus-mongodb-query-exporter/README.md

@@ -29,6 +29,7 @@ populate the `podAnnotations` as below:
 podAnnotations:
   prometheus.io/scrape: "true"
   prometheus.io/port: "metrics"
+  prometheus.io/path: "/metrics"
 ```
 
 ## Configuration

chart/prometheus-mongodb-query-exporter/templates/NOTES.txt

@@ -2,12 +2,12 @@ Verify the application is working by running these commands:
 {{if contains "NodePort" .Values.service.type }}
   NODE_IP=$(kubectl get nodes --namespace {{ .Release.Namespace }} -o jsonpath="{.items[0].status.addresses[0].address}")
   NODE_PORT=$(kubectl get --namespace {{ .Release.Namespace }} -o jsonpath="{.spec.ports[0].nodePort}" services {{ include "prometheus-mongodb-query-exporter.fullname" . }})
-  curl http://$NODE_IP:$NODE_PORT/metrics
+  curl http://$NODE_IP:$NODE_PORT{{ .Values.metricsPath }}
 {{- else if contains "LoadBalancer" .Values.service.type }}
   # NOTE: It may take a few minutes for the LoadBalancer IP to be available.
   SERVICE_IP=$(kubectl get svc --namespace {{ .Release.Namespace }} {{ include "prometheus-mongodb-query-exporter.fullname" . }} -o jsonpath='{.status.loadBalancer.ingress[0].ip}')
-  curl http://$SERVICE_IP:{{ .Values.service.port }}/metrics
+  curl http://$SERVICE_IP:{{ .Values.service.port }}{{ .Values.metricsPath }}
 {{- else if contains "ClusterIP" .Values.service.type }}
   kubectl port-forward service/{{ include "prometheus-mongodb-query-exporter.fullname" . }} {{ .Values.service.port }}
-  curl http://127.0.0.1:{{ .Values.service.port }}/metrics
+  curl http://127.0.0.1:{{ .Values.service.port }}{{ .Values.metricsPath }}
 {{- end }}

chart/prometheus-mongodb-query-exporter/templates/deployment.yaml

@@ -56,6 +56,7 @@ spec:
         imagePullPolicy: {{ .Values.image.pullPolicy }}
         args:
         - --bind={{ printf ":%s" .Values.port }}
+        - --path={{ .Values.metricsPath }}
         {{- if .Values.extraArgs }}
         {{- toYaml .Values.extraArgs | nindent 8 }}
         {{- end }}

chart/prometheus-mongodb-query-exporter/templates/servicemonitor.yaml

@@ -19,6 +19,7 @@ metadata:
 spec:
   endpoints:
   - port: metrics
+    path: {{ .Values.metricsPath }}
     interval: {{ .Values.serviceMonitor.interval }}
     scrapeTimeout: {{ .Values.serviceMonitor.scrapeTimeout }}
     {{- if .Values.serviceMonitor.metricRelabelings }}

chart/prometheus-mongodb-query-exporter/templates/tests/test-connection.yaml

@@ -14,5 +14,5 @@ spec:
   - name: wget
     image: busybox
     command: ['wget']
-    args:  ['-qO-', '{{ include "prometheus-mongodb-query-exporter.fullname" . }}:{{ .Values.service.port }}/metrics']
+    args:  ['-qO-', '{{ include "prometheus-mongodb-query-exporter.fullname" . }}:{{ .Values.service.port }}{{ .Values.metricsPath }}']
   restartPolicy: Never

chart/prometheus-mongodb-query-exporter/values.yaml

@@ -9,7 +9,7 @@ fullnameOverride: ""
 image:
   pullPolicy: IfNotPresent
   repository: raffis/mongodb-query-exporter
-  tag: v1.0.0-beta6
+  tag: v1.0.0-beta7
 
 imagePullSecrets: []
 
@@ -87,6 +87,9 @@ podAnnotations: {}
 
 port: "9412"
 
+# Change the metrics path
+metricsPath: /metrics
+
 priorityClassName: ""
 
 readinessProbe:

cmd/root.go

@@ -1,6 +1,7 @@
 package cmd
 
 import (
+	"fmt"
 	"net/http"
 	"os"
 	"os/user"
@@ -23,6 +24,7 @@ var (
 	logEncoding  string
 	bind         string
 	uri          string
+	metricsPath  string
 	queryTimeout int
 	rootCmd      = &cobra.Command{
 		Use:   "mongodb_query_exporter",
@@ -64,23 +66,25 @@ var (
 
 			prometheus.MustRegister(c)
 			c.StartCacheInvalidator()
-			serve(prometheus.DefaultGatherer, conf.GetBindAddr())
+			serve(prometheus.DefaultGatherer, conf)
 		},
 	}
 )
 
-// Run executes a blocking http server. Starts the http listener with the /metrics endpoint
-// and parses all configured metrics passed by config
-func serve(reg prometheus.Gatherer, addr string) {
-	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
-		http.Error(w, "Use the /metrics endpoint", http.StatusOK)
-	})
+// Run executes a blocking http server. Starts the http listener with the metrics and healthz endpoints.
+func serve(reg prometheus.Gatherer, conf config.Config) {
+	if conf.GetMetricsPath() != "/" {
+		http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
+			http.Error(w, fmt.Sprintf("Use the %s endpoint", conf.GetMetricsPath()), http.StatusOK)
+		})
+	}
+
 	http.HandleFunc("/healthz", func(w http.ResponseWriter, r *http.Request) { http.Error(w, "OK", http.StatusOK) })
-	http.HandleFunc("/metrics", func(w http.ResponseWriter, r *http.Request) {
+	http.HandleFunc(conf.GetMetricsPath(), func(w http.ResponseWriter, r *http.Request) {
 		promhttp.HandlerFor(reg, promhttp.HandlerOpts{}).ServeHTTP(w, r)
 	})
 
-	err := http.ListenAndServe(addr, nil)
+	err := http.ListenAndServe(conf.GetBindAddr(), nil)
 
 	// If the port is already in use or another fatal error panic
 	if err != nil {
@@ -103,17 +107,20 @@ func init() {
 	rootCmd.PersistentFlags().StringVarP(&logLevel, "log-level", "l", "info", "Define the log level (default is info) [debug,info,warning,error]")
 	rootCmd.PersistentFlags().StringVarP(&logEncoding, "log-encoding", "e", "json", "Define the log format (default is json) [json,console]")
 	rootCmd.PersistentFlags().StringVarP(&bind, "bind", "b", ":9412", "Address to bind http server (default is :9412)")
+	rootCmd.PersistentFlags().StringVarP(&metricsPath, "path", "p", "/metrics", "Metric path (default is /metrics)")
 	rootCmd.PersistentFlags().IntVarP(&queryTimeout, "query-timeout", "t", 10, "Timeout for MongoDB queries")
 	viper.BindPFlag("log.level", rootCmd.PersistentFlags().Lookup("log-level"))
 	viper.BindPFlag("log.encoding", rootCmd.PersistentFlags().Lookup("log-encoding"))
 	viper.BindPFlag("bind", rootCmd.PersistentFlags().Lookup("bind"))
+	viper.BindPFlag("metricsPath", rootCmd.PersistentFlags().Lookup("path"))
 	viper.BindPFlag("mongodb.uri", rootCmd.PersistentFlags().Lookup("uri"))
 	viper.BindPFlag("mongodb.queryTimeout", rootCmd.PersistentFlags().Lookup("query-timeout"))
 	viper.BindEnv("mongodb.uri", "MDBEXPORTER_MONGODB_URI")
 	viper.BindEnv("global.queryTimeout", "MDBEXPORTER_MONGODB_QUERY_TIMEOUT")
 	viper.BindEnv("log.level", "MDBEXPORTER_LOG_LEVEL")
 	viper.BindEnv("log.encoding", "MDBEXPORTER_LOG_ENCODING")
 	viper.BindEnv("bind", "MDBEXPORTER_BIND")
+	viper.BindEnv("metricsPath", "MDBEXPORTER_METRICSPATH")
 }
 
 func initConfig() {