improved, refactored

Author: Christian González Di Antonio

.github/workflows/release.yml

@@ -99,11 +99,17 @@ jobs:
       - name: List .build Files
         run: ls -R .build
 
+      - name: Set Env Var RELEASE_VERSION
+        run: echo ::set-env name=RELEASE_VERSION::${GITHUB_REF#refs/*/}
+
+      - name: Show RELEASE_VERSION
+        run: echo $RELEASE_VERSION
+
       - name: Build Docker Images
-        run: make docker DOCKER_REPO=docker.io/slashdevops
+        run: make docker DOCKER_IMAGE_TAG=$RELEASE_VERSION DOCKER_REPO=docker.io/slashdevops
 
       - name: Docker Tag Images Latest
-        run: make docker-tag-latest DOCKER_REPO=docker.io/slashdevops
+        run: make docker-tag-latest DOCKER_IMAGE_TAG=$RELEASE_VERSION DOCKER_REPO=docker.io/slashdevops
 
       - name: Show Local Docker Images
         run: docker images
@@ -112,10 +118,10 @@ jobs:
         run: echo ${{ secrets.DOCKER_HUB_PASSWORD }} | docker login -u ${{ secrets.DOCKER_HUB_USER }} --password-stdin
 
       - name: Publish Images in Docker Hub
-        run: make docker-publish DOCKER_REPO=$DOCKER_HUB_REPO
+        run: make docker-publish DOCKER_IMAGE_TAG=$RELEASE_VERSION DOCKER_REPO=$DOCKER_HUB_REPO
 
       - name: Publish Manifest in Docker Hub
-        run: make docker-manifest DOCKER_REPO=$DOCKER_HUB_REPO
+        run: make docker-manifest DOCKER_IMAGE_TAG=$RELEASE_VERSION DOCKER_REPO=$DOCKER_HUB_REPO
 
   create_release:
     name: Create Release

cmd/metrics.go

@@ -173,8 +173,10 @@ func collectCmd(cmd *cobra.Command, args []string) {
 
 	m := metrics.New(&conf)
 	sess := awshelper.NewSession(&conf.AWS)
+	cwc := cloudwatch.New(sess)
+
+	c := collector.New(&conf, m, cwc)
 
-	c := collector.New(&conf, m, sess)
 	prometheus.MustRegister(c)
 	http.Handle("/metrics", promhttp.Handler())
 

cmd/server.go

@@ -20,6 +20,7 @@ import (
 	"net/http/pprof"
 	"time"
 
+	"github.com/aws/aws-sdk-go/service/cloudwatch"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/client_golang/prometheus/promhttp"
 	"github.com/slashdevops/aws_cloudwatch_exporter/internal/awshelper"
@@ -122,9 +123,11 @@ func startCmd(cmd *cobra.Command, args []string) {
 
 	m := metrics.New(&conf)
 	sess := awshelper.NewSession(&conf.AWS)
+	cwc := cloudwatch.New(sess)
 
-	collector := collector.New(&conf, m, sess)
-	prometheus.MustRegister(collector)
+	c := collector.New(&conf, m, cwc)
+
+	prometheus.MustRegister(c)
 
 	handlers := web.NewHandlers(&conf)
 
@@ -134,20 +137,18 @@ func startCmd(cmd *cobra.Command, args []string) {
 	mux.Handle(conf.Application.MetricsPath, promhttp.Handler())
 
 	// Debug & Profiling
-	if conf.Server.Debug {
-		mux.HandleFunc("/debug/pprof/", pprof.Index)
-		mux.HandleFunc("/debug/pprof/heap", pprof.Index)
-		mux.HandleFunc("/debug/pprof/mutex", pprof.Index)
-		mux.HandleFunc("/debug/pprof/goroutine", pprof.Index)
-		mux.HandleFunc("/debug/pprof/threadcreate", pprof.Index)
-		mux.HandleFunc("/debug/pprof/block", pprof.Index)
-		mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
-		mux.HandleFunc("/debug/pprof/profile", pprof.Profile)
-		mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
-		mux.HandleFunc("/debug/pprof/trace", pprof.Trace)
-	}
-
-	// this channel is to wait routines before finis this
+	mux.HandleFunc("/debug/pprof/", pprof.Index)
+	mux.HandleFunc("/debug/pprof/heap", pprof.Index)
+	mux.HandleFunc("/debug/pprof/mutex", pprof.Index)
+	mux.HandleFunc("/debug/pprof/goroutine", pprof.Index)
+	mux.HandleFunc("/debug/pprof/threadcreate", pprof.Index)
+	mux.HandleFunc("/debug/pprof/block", pprof.Index)
+	mux.HandleFunc("/debug/pprof/cmdline", pprof.Cmdline)
+	mux.HandleFunc("/debug/pprof/profile", pprof.Profile)
+	mux.HandleFunc("/debug/pprof/symbol", pprof.Symbol)
+	mux.HandleFunc("/debug/pprof/trace", pprof.Trace)
+
+	// this channel is to wait routines
 	done := make(chan bool, 1)
 	s := server.New(mux, &conf)
 

docs/credentials.md

@@ -4,13 +4,9 @@ This is the credentials' configuration file options
 
 ```yaml
 aws:
-  session_token: ""
   region: ""
   profile: ""
   role_arn: ""
-  role_session_name: ""
-  web_identity_token_file: ""
-  external_id: ""
 ```
 
 ## Help links

internal/awshelper/session_test.go

@@ -133,7 +133,7 @@ func TestNewSessionWithFiles(t *testing.T) {
 			Expected: map[string]string{
 				"AWS_ACCESS_KEY_ID":           "AKIAIOSFODNN7EXAMPLE",
 				"AWS_SECRET_ACCESS_KEY":       "wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY",
-				"AWS_REGION":                  "us-west-1",
+				"AWS_REGION":                  "eu-west-1",
 				"AWS_SHARED_CREDENTIALS_FILE": "SharedConfigCredentials: testdata/case1/credentials",
 			},
 		},

internal/collector/collector.go

@@ -21,7 +21,6 @@ import (
 	"sync"
 	"time"
 
-	"github.com/aws/aws-sdk-go/aws/session"
 	"github.com/aws/aws-sdk-go/service/cloudwatch"
 	"github.com/prometheus/client_golang/prometheus"
 	"github.com/prometheus/common/log"
@@ -51,16 +50,16 @@ type OwnMetrics struct {
 
 type Collector struct {
 	conf       *config.All
-	sess       *session.Session
+	svc        *cloudwatch.CloudWatch
 	metrics    metrics.Metrics
 	mutex      sync.RWMutex
 	ownMetrics *OwnMetrics
 }
 
-func New(c *config.All, m metrics.Metrics, s *session.Session) *Collector {
+func New(c *config.All, m metrics.Metrics, cwc *cloudwatch.CloudWatch) *Collector {
 	return &Collector{
 		conf:    c,
-		sess:    s,
+		svc:     cwc,
 		metrics: m,
 		ownMetrics: &OwnMetrics{
 			Up: prometheus.NewGauge(prometheus.GaugeOpts{
@@ -209,14 +208,8 @@ func (c *Collector) scrape(ch chan<- prometheus.Metric) {
 	// number of metrics to be scrape and defined in yaml files
 	c.ownMetrics.MetricsTotal.Set(float64(len(mdi.MetricDataQueries)))
 
-	// TODO: Remove it from here and implement a new interface and package to collect metrics
-	// but it is here because every time the exporter going to scrape metrics the
-	// cloudwatch session is refreshed, I need to be sure that credential never expired
-	// when move it from here
-	svc := cloudwatch.New(c.sess)
-
 	// Scrape CloudWatch Metrics
-	mdo, err := svc.GetMetricData(mdi)
+	mdo, err := c.svc.GetMetricData(mdi)
 	if err != nil {
 		c.ownMetrics.Up.Set(0)
 		c.ownMetrics.ScrapesErrors.Inc()

internal/web/handlers.go

@@ -55,17 +55,12 @@ func (h *Handlers) Home(w http.ResponseWriter, r *http.Request) {
 		<li>{{.BuildInfo}}</li>
 	</ul>
 	
-	{{ if .Debug }}
-	<h2>Debug is enabled</h2>
-	<h3>Links:</h3>
+	<h2>Go profile is enabled</h2>
 	<ul>
-		{{range .DebugLinks}}
+		{{range .ProfileLinks}}
 		<li><a href="{{.}}">{{.}}</a></li>
 		{{ end }}
 	</ul>
-	{{ else }}
-	<h2>Debug is disabled, you cannot see application performance profile</h2>
-	{{ end }}
 
 	<h3><a href="https://prometheus.io/">https://prometheus.io</a></h3>
 </body>
@@ -80,8 +75,7 @@ func (h *Handlers) Home(w http.ResponseWriter, r *http.Request) {
 		HealthPath    string
 		VersionInfo   string
 		BuildInfo     string
-		Debug         bool
-		DebugLinks    []string
+		ProfileLinks  []string
 	}{
 		h.conf.Application.Name,
 		h.conf.Application.Name,
@@ -91,7 +85,6 @@ func (h *Handlers) Home(w http.ResponseWriter, r *http.Request) {
 		h.conf.Application.HealthPath,
 		h.conf.Application.VersionInfo,
 		h.conf.Application.BuildInfo,
-		h.conf.Server.Debug,
 		[]string{
 			"/debug/pprof/",
 			"/debug/pprof/heap",