Merge branch 'master' into master

Author: galbirk

.github/workflows/main.yml

@@ -10,12 +10,12 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Setup Go
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
-          go-version: '1.19.5'
+          go-version: '1.22.1'
 
       - name: Install dependencies
         run: go get .

.gitignore

@@ -2,3 +2,6 @@
 *.pem
 .idea/
 .vscode/
+
+# Build artifact
+./main

Dockerfile

@@ -1,16 +1,16 @@
-FROM golang:1.19.5-buster as build
-LABEL maintainer="Infinity Works"
+FROM golang:1.22-bookworm as build
+LABEL maintainer="githubexporter"
 
 ENV GO111MODULE=on
 
-COPY ./ /go/src/github.com/infinityworks/github-exporter
-WORKDIR /go/src/github.com/infinityworks/github-exporter
+COPY ./ /go/src/github.com/githubexporter/github-exporter
+WORKDIR /go/src/github.com/githubexporter/github-exporter
 
 RUN go mod download \
     && go test ./... \
     && CGO_ENABLED=0 GOOS=linux go build -o /bin/main
 
-FROM alpine:3.17.1
+FROM alpine:3
 
 RUN apk --no-cache add ca-certificates \
      && addgroup exporter \

Makefile

@@ -7,4 +7,4 @@ test:
 	@go test -v -race ./...
 
 build:
-	@go build ./...
+	@go build -o main

README.md

@@ -1,4 +1,11 @@
-[![Build Status](https://travis-ci.org/infinityworks/github-exporter.svg?branch=master)](https://travis-ci.org/infinityworks/github-exporter)
+# :warning: This repository is moving to the [githubexporter](https://github.com/githubexporter) organisation at [githubexporter/github-exporter](https://github.com/githubexporter/github-exporter) :warning:
+
+Timeline of changes:
+* 22/05/2023 - All current images are available in the new Docker Hub organisation at https://hub.docker.com/r/githubexporter/github-exporter
+* 30/05/2023 - GitHub repository will be migrated to https://github.com/githubexporter/github-exporter
+* 30/05/2023 - Any new images will be pushed to the `githubexporter` Docker Hub repository only
+* 21/08/2023 - All existing images will be removed from the `infinityworks/github-exporter` Docker Hub repository.
+* 30/08/2023 - The `infinityworks/github-exporter` Docker Hub repository will be deprecated
 
 # Prometheus GitHub Exporter
 
@@ -11,7 +18,7 @@ This exporter is setup to take input from environment variables. All variables a
 * `ORGS` If supplied, the exporter will enumerate all repositories for that organization. Expected in the format "org1, org2".
 * `REPOS` If supplied, The repos you wish to monitor, expected in the format "user/repo1, user/repo2". Can be across different Github users/orgs.
 * `USERS` If supplied, the exporter will enumerate all repositories for that users. Expected in
-the format "user1, user2".
+  the format "user1, user2".
 * `GITHUB_TOKEN` If supplied, enables the user to supply a github authentication token that allows the API to be queried more often. Optional, but recommended.
 * `GITHUB_TOKEN_FILE` If supplied _instead of_ `GITHUB_TOKEN`, enables the user to supply a path to a file containing a github authentication token that allows the API to be queried more often. Optional, but recommended.
 * `GITHUB_APP` If true , authenticates ass GitHub app to the API.
@@ -29,7 +36,7 @@ the format "user1, user2".
 
 Run manually from Docker Hub:
 ```
-docker run -d --restart=always -p 9171:9171 -e REPOS="infinityworks/ranch-eye, infinityworks/prom-conf" infinityworks/github-exporter
+docker run -d --restart=always -p 9171:9171 -e REPOS="infinityworks/ranch-eye, infinityworks/prom-conf" githubexporter/github-exporter
 ```
 
 Run manually from Docker Hub (With GitHub App):
@@ -52,7 +59,7 @@ github-exporter:
       - 9171
     ports:
       - 9171:9171
-    image: infinityworks/github-exporter:latest
+    image: githubexporter/github-exporter:latest
     environment:
       - REPOS=<REPOS you want to monitor>
       - GITHUB_TOKEN=<your github api token>
@@ -89,7 +96,7 @@ An example of these metrics can be found in the `METRICS.md` markdown file in th
 
 ## Tests
 
-There is a set of blackbox behavioural tests which validate metrics endpoint in the `test` directory. 
+There is a set of blackbox behavioural tests which validate metrics endpoint in the `test` directory.
 Run as follows
 
 ```bash
@@ -99,7 +106,7 @@ make test
 ## Version Release Procedure
 Once a new pull request has been merged into `master` the following script should be executed locally. The script will trigger a new image build in docker hub with the new image having the tag `release-<version>`. The version is taken from the `VERSION` file and must follow semantic versioning. For more information see [semver.org](https://semver.org/).
 
-Prior to running the following command ensure the number has been increased to desired version in `VERSION`: 
+Prior to running the following command ensure the number has been increased to desired version in `VERSION`:
 
 ```bash
 ./release-version.sh

VERSION

@@ -1 +1 @@
-1.0.3
+1.1.0

config/config.go

@@ -132,7 +132,7 @@ func (c *Config) SetAPIToken(token string) {
 
 // SetAPITokenFromFile accepts a file containing an oauth2 token for usage in http.request
 func (c *Config) SetAPITokenFromFile(tokenFile string) error {
-	b, err := ioutil.ReadFile(tokenFile)
+	b, err := os.ReadFile(tokenFile)
 	if err != nil {
 		return err
 	}
@@ -181,6 +181,8 @@ func (c *Config) setScrapeURLs() error {
 	}
 
 	// Append github orginisations to the array
+  
+  
 	if len(c.organisations) > 0 {
 		for _, x := range c.organisations {
 			y := *c.apiUrl

docker-compose.yml

@@ -8,7 +8,7 @@ services:
       - 9171
     ports:
       - 9171:9171
-    image: infinityworks/github-exporter:latest
+    image: githubexporter/github-exporter:latest
     environment:
       - REPOS=<REPOS you want to monitor>
       - GITHUB_TOKEN=<your github api token>

exporter/http.go

@@ -2,7 +2,7 @@ package exporter
 
 import (
 	"fmt"
-	"io/ioutil"
+	"io"
 	"net/http"
 	neturl "net/url"
 	"strconv"
@@ -40,7 +40,7 @@ func asyncHTTPGets(targets []string, token string) ([]*Response, error) {
 		case r := <-ch:
 			if r.err != nil {
 				log.Errorf("Error scraping API, Error: %v", r.err)
-				break
+				return nil, r.err
 			}
 			responses = append(responses, r)
 
@@ -111,7 +111,7 @@ func getResponse(url string, token string, ch chan<- *Response) error {
 	defer resp.Body.Close()
 
 	// Read the body to a byte array so it can be used elsewhere
-	body, err := ioutil.ReadAll(resp.Body)
+	body, err := io.ReadAll(resp.Body)
 	if err != nil {
 		return fmt.Errorf("Error converting body to byte array: %v", err)
 	}

exporter/metrics.go

@@ -1,7 +1,10 @@
 package exporter
 
-import "github.com/prometheus/client_golang/prometheus"
-import "strconv"
+import (
+	"strconv"
+
+	"github.com/prometheus/client_golang/prometheus"
+)
 
 // AddMetrics - Add's all of the metrics to a map of strings, returns the map.
 func AddMetrics() map[string]*prometheus.Desc {
@@ -21,7 +24,7 @@ func AddMetrics() map[string]*prometheus.Desc {
 	APIMetrics["PullRequestCount"] = prometheus.NewDesc(
 		prometheus.BuildFQName("github", "repo", "pull_request_count"),
 		"Total number of pull requests for given repository",
-		[]string{"repo"}, nil,
+		[]string{"repo", "user"}, nil,
 	)
 	APIMetrics["Watchers"] = prometheus.NewDesc(
 		prometheus.BuildFQName("github", "repo", "watchers"),
@@ -41,7 +44,7 @@ func AddMetrics() map[string]*prometheus.Desc {
 	APIMetrics["ReleaseDownloads"] = prometheus.NewDesc(
 		prometheus.BuildFQName("github", "repo", "release_downloads"),
 		"Download count for a given release",
-		[]string{"repo", "user", "release", "name", "created_at"}, nil,
+		[]string{"repo", "user", "release", "name", "tag", "created_at"}, nil,
 	)
 	APIMetrics["Limit"] = prometheus.NewDesc(
 		prometheus.BuildFQName("github", "rate", "limit"),
@@ -74,7 +77,7 @@ func (e *Exporter) processMetrics(data []*Datum, rates *RateLimits, ch chan<- pr
 
 		for _, release := range x.Releases {
 			for _, asset := range release.Assets {
-				ch <- prometheus.MustNewConstMetric(e.APIMetrics["ReleaseDownloads"], prometheus.GaugeValue, float64(asset.Downloads), x.Name, x.Owner.Login, release.Name, asset.Name, asset.CreatedAt)
+				ch <- prometheus.MustNewConstMetric(e.APIMetrics["ReleaseDownloads"], prometheus.GaugeValue, float64(asset.Downloads), x.Name, x.Owner.Login, release.Name, asset.Name, release.Tag, asset.CreatedAt)
 			}
 		}
 		prCount := 0
@@ -85,7 +88,7 @@ func (e *Exporter) processMetrics(data []*Datum, rates *RateLimits, ch chan<- pr
 		ch <- prometheus.MustNewConstMetric(e.APIMetrics["OpenIssues"], prometheus.GaugeValue, (x.OpenIssues - float64(prCount)), x.Name, x.Owner.Login, strconv.FormatBool(x.Private), strconv.FormatBool(x.Fork), strconv.FormatBool(x.Archived), x.License.Key, x.Language)
 
 		// prCount
-		ch <- prometheus.MustNewConstMetric(e.APIMetrics["PullRequestCount"], prometheus.GaugeValue, float64(prCount), x.Name)
+		ch <- prometheus.MustNewConstMetric(e.APIMetrics["PullRequestCount"], prometheus.GaugeValue, float64(prCount), x.Name, x.Owner.Login)
 	}
 
 	// Set Rate limit stats