Add option to disable metrics collection logging (#82)

* exporter: implement option for disabling metric collection logging
* helm: add helm chart option to disable metric collection logging
* exporter: move log metric collection parse err earlier
* bump version and add docs to README

Author: rfox-codecov

README.md

@@ -10,6 +10,8 @@ Helm Chart with values and deployment can be found [here](./helm/github-rate-lim
 
 For the exporter to run you need to supply either a GitHub Token or a set of a GitHub App credentials, alongside with a type of authentication to use(pat/app)
 
+You can use the environment variable `GITHUB_LOG_METRIC_COLLECTION` (boolean) to control if rate limit metrics are also logged to the console when they're collected by Prometheus. As the functionality is backed by [Golang `strconv.ParseBool`](https://pkg.go.dev/strconv#ParseBool), it accepts 1, t, T, TRUE, true, True, 0, f, F, FALSE, false, False. Any other value or lack thereof will default to enabling logs.
+
 ### The metrics can then be represented on a [grafana](https://grafana.com) dashboard
 
 

helm/github-rate-limits-prometheus-exporter/Chart.yaml

@@ -15,10 +15,10 @@ 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: 0.2.12
+version: 0.2.13
 
 # 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
 # follow Semantic Versioning. They should reflect the version the application is using.
 # It is recommended to use it with quotes.
-appVersion: "v3.0.0"
+appVersion: "v3.1.0"

helm/github-rate-limits-prometheus-exporter/templates/deployment.yaml

@@ -34,6 +34,8 @@ spec:
           image: "{{ .Values.image.repository }}:{{ .Values.image.tag | default .Chart.AppVersion }}"
           imagePullPolicy: {{ .Values.image.pullPolicy }}
           env:
+            - name: GITHUB_LOG_METRIC_COLLECTION
+              value: {{ .Values.logging.logMetricCollection | default "true" }}
           {{- if eq .Values.github.authType "app" }}
             - name: GITHUB_AUTH_TYPE
               value: {{ .Values.github.authType | upper | quote }}

helm/github-rate-limits-prometheus-exporter/values.yaml

@@ -17,6 +17,9 @@ github:
 
 replicaCount: 1
 
+logging:
+  logMetricCollection: true
+
 image:
   repository: ghcr.io/kalgurn/grl-exporter
   pullPolicy: IfNotPresent

internal/prometheus_exporter/server.go

@@ -3,6 +3,7 @@ package prometheus_exporter
 import (
 	"log"
 	"net/http"
+	"strconv"
 	"time"
 
 	"github.com/kalgurn/github-rate-limits-prometheus-exporter/internal/github_client"
@@ -12,7 +13,8 @@ import (
 )
 
 var (
-	githubAccount = utils.GetOSVar("GITHUB_ACCOUNT_NAME")
+	githubAccount                                    = utils.GetOSVar("GITHUB_ACCOUNT_NAME")
+	logMetricCollection, logMetricCollectionParseErr = strconv.ParseBool(utils.GetOSVar("GITHUB_LOG_METRIC_COLLECTION"))
 )
 
 func newLimitsCollector() *LimitsCollector {
@@ -51,8 +53,10 @@ func (collector *LimitsCollector) Collect(ch chan<- prometheus.Metric) {
 
 	auth := github_client.InitConfig()
 	limits := github_client.GetRemainingLimits(auth.InitClient())
-	log.Printf("Collected metrics for %s", githubAccount)
-	log.Printf("Limit: %d | Used: %d | Remaining: %d", limits.Limit, limits.Used, limits.Remaining)
+	if logMetricCollection {
+		log.Printf("Collected metrics for %s", githubAccount)
+		log.Printf("Limit: %d | Used: %d | Remaining: %d", limits.Limit, limits.Used, limits.Remaining)
+	}
 	//Write latest value for each metric in the prometheus metric channel.
 	//Note that you can pass CounterValue, GaugeValue, or UntypedValue types here.
 	m1 := prometheus.MustNewConstMetric(collector.LimitTotal, prometheus.GaugeValue, float64(limits.Limit))
@@ -70,6 +74,11 @@ func (collector *LimitsCollector) Collect(ch chan<- prometheus.Metric) {
 }
 
 func Run() {
+	// Default to logging metric collection
+	if logMetricCollectionParseErr != nil {
+		logMetricCollection = true
+	}
+
 	limit := newLimitsCollector()
 	prometheus.NewRegistry()
 	prometheus.MustRegister(limit)

version.json

@@ -1,4 +1,4 @@
 {
   "name": "github-rate-limits-prometheus-exporter",
-  "version": "3.0.0"
+  "version": "3.1.0"
 }