(feat) Improved project CI (#11)

* Rename project name references

* Switch Docker registry to a new one

* Remove goreleaser format deprecation

* Improved CI tests, some refactoring

Author: MGSousa

.github/workflows/release.yml

@@ -53,4 +53,4 @@ jobs:
           context: .
           file: Dockerfile.release
           push: true
-          tags: mgsousa/prom-exporter:latest,mgsousa/prom-exporter:${{ steps.prepare.outputs.tag_name }}
+          tags: mgsousa/json-stats-exporter:${{ steps.prepare.outputs.tag_name }},mgsousa/json-stats-exporter:latest

.github/workflows/test.yml

@@ -10,17 +10,20 @@ jobs:
   test:
     runs-on: ubuntu-latest
 
+    services:
+      http-service:
+        image: hashicorp/http-echo:latest
+        env:
+          ECHO_TEXT: '{"stats":{"events":{"active":0,"added":0,"done":0},"harvester":{"closed":0,"open_files":0,"running":0,"skipped":0,"started":0},"input":{"log":{"files":{"renamed":0,"truncated":0}}}},"processor":{"rate_limit":{"1":{"dropped":0}}},"writes":{"fail":0,"success":0,"total":0},"system":{"cpu":{"cores":4},"load":{"1":0.45,"15":0.21,"5":0.26,"norm":{"1":0.105,"15":0.05,"5":0.065}}}}'
+        ports:
+          - 5678:5678
+
     steps:
       - name: Checkout
         uses: actions/checkout@v4
         with:
           fetch-depth: 0
 
-      - name: Set up Go
-        uses: actions/setup-go@master
-        with:
-          go-version: 1.21.x
-
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
@@ -30,14 +33,13 @@ jobs:
         with:
           context: .
           load: true
-          tags: prom-exporter:test
+          tags: json-stats-exporter:test
 
-      - name: Test Execution
+      - name: Run Service
         run: |
-          timeout 10s docker run --rm prom-exporter:test \
-            -listen-address ":9201" \
-            -service-name "test" -service-uri "test" -service-port "5066" -service-metrics-path "stats" || code=$?
-          if [[ $code -ne 124 ]]; then
-            echo "Exporter stopped with ${code}. It was expected to run forever."
-            exit 1;
-          fi
+          docker run --net=host --rm json-stats-exporter:test \
+            -listen-address ":9201" -service-name "test" \
+            -service-uri "localhost" -service-port "5678" &
+
+          sleep 10
+          curl -sS --fail-with-body --retry 5 localhost:9201/metrics

.goreleaser.yml

@@ -1,4 +1,5 @@
-project_name: prom-exporter
+version: 2
+project_name: json-stats-exporter
 
 builds:
   - env:
@@ -13,7 +14,7 @@ builds:
     ldflags:
       - -s -w
 archives:
-  - format: binary
+  - formats: binary
 checksum:
   disable: true
 snapshot:

Dockerfile

@@ -14,6 +14,6 @@ FROM scratch
 
 WORKDIR /app
 
-COPY --from=build /app/dist/prom-exporter_linux_amd64_v1/* ./prom-exporter
+COPY --from=build /app/dist/json-stats-exporter_linux_amd64_v1/* ./json-stats-exporter
 
-ENTRYPOINT [ "./prom-exporter" ]
+ENTRYPOINT [ "./json-stats-exporter" ]

Dockerfile.release

@@ -2,6 +2,6 @@ FROM scratch
 
 WORKDIR /app
 
-COPY ./dist/prom-exporter_linux_amd64_v1/prom-exporter ./ 
+COPY ./dist/json-stats-exporter_linux_amd64_v1/json-stats-exporter ./ 
 
-ENTRYPOINT [ "./prom-exporter" ]
+ENTRYPOINT [ "./json-stats-exporter" ]

Makefile

@@ -1,4 +1,4 @@
-BINARY = prom-exporter
+BINARY = json-stats-exporter
 ACT_URL = https://raw.githubusercontent.com/nektos/act/master/install.sh
 
 ACT := $(shell command -v act)
@@ -8,14 +8,17 @@ ACT := $(shell command -v act)
 test: test_sec test_ci
 
 act:
-	@[ ! -x "$(ACT)" ] && (curl --proto '=https' --tlsv1.2 -sSf $(ACT_URL) | sudo bash && sudo install ./bin/act /usr/local/bin/) || true
+	@curl --proto '=https' --tlsv1.2 -sSf $(ACT_URL) | bash
 
 test_ci: act
 	@act push --rm -j "test"
 
 test_sec: act
 	@act push --rm -j "security"
 
+benchmark:
+	@go test -v ./... -bench=^BenchmarkBuild
+
 docker_build:
 	@docker build --no-cache -t $(BINARY) .
 

README.md

@@ -1,9 +1,9 @@
-# <img src="https://static-00.iconduck.com/assets.00/prometheus-icon-511x512-1vmxbcxr.png" width="50"/>  Auto Prometheus Exporter
-[![Release](https://github.com/MGSousa/prom-exporter/actions/workflows/release.yml/badge.svg)](https://github.com/MGSousa/prom-exporter/actions/workflows/release.yml)
-[![Docker Version](https://img.shields.io/docker/v/mgsousa/prom-exporter.svg)](https://hub.docker.com/r/MGSousa/prom-exporter/)
-[![Docker Pulls](https://img.shields.io/docker/pulls/mgsousa/prom-exporter.svg)](https://hub.docker.com/r/MGSousa/prom-exporter/)
+# <img src="https://static-00.iconduck.com/assets.00/prometheus-icon-511x512-1vmxbcxr.png" width="50"/>  JSON Stats Exporter
 
-Prometheus exporter that fetches and auto-resolves JSON data from selected services by converting metrics/stats in Prometheus format, being ready to be scrapped.
+[![CI](https://github.com/MGSousa/json-stats-exporter/actions/workflows/release.yml/badge.svg)](https://github.com/MGSousa/json-stats-exporter/actions/workflows/release.yml)
+[![Version](https://img.shields.io/github/release/MGSousa/json-stats-exporter.svg?style=flat)]()
+
+Prometheus exporter that scrapes and parses JSON statistics from selected services by converting metrics/stats in Prometheus format, being ready to be scrapped.
 
 Compatible with Elastic Beats plugins (Filebeat, Auditbeat, Packetbeat, Metricbeat, etc.) and any other tool with HTTP endpoint output in JSON.
 
@@ -12,24 +12,24 @@ Compatible with Elastic Beats plugins (Filebeat, Auditbeat, Packetbeat, Metricbe
   - specify version
 ```sh
 VERSION=1.0.0
-wget -nv https://github.com/MGSousa/prom-exporter/releases/download/v$VERSION/prom-exporter_${VERSION}_$(uname | awk '{print tolower($0)}')_amd64 -O prom-exporter && chmod +x prom-exporter
+wget -nv https://github.com/MGSousa/json-stats-exporter/releases/download/v$VERSION/json-stats-exporter_${VERSION}_$(uname | awk '{print tolower($0)}')_amd64 -O json-stats-exporter && chmod +x json-stats-exporter
 ```
 
   - or fetch the latest release
 ```sh
-curl -fsL "https://api.github.com/repos/MGSousa/prom-exporter/releases/latest" |\
+curl -fsL "https://api.github.com/repos/MGSousa/json-stats-exporter/releases/latest" |\
     jq -r ".assets[] | select(.name|contains(\"$(uname | awk '{print tolower($0)}')\")) | .url" |\
-    wget --header="Accept: application/octet-stream" -O prom-exporter -nv -i - && chmod +x prom-exporter
+    wget --header="Accept: application/octet-stream" -O json-stats-exporter -nv -i - && chmod +x json-stats-exporter
 ```
 ### Windows
 ```sh
-curl -o prom-exporter.exe https://github.com/MGSousa/prom-exporter/releases/download/v1.0.0/prom-exporter_1.0.0_windows_amd64.exe
+curl -o json-stats-exporter.exe https://github.com/MGSousa/json-stats-exporter/releases/download/v1.0.0/json-stats-exporter_1.0.0_windows_amd64.exe
 ```
 
 ## Usage
  - About args
 ```sh
-Usage of ./prom-exporter:
+Usage of ./json-stats-exporter:
   -debug
     	Enable debug mode.
   -listen-address string
@@ -114,7 +114,7 @@ services:
 ```
  - Run it via executable
 ```sh
-./prom-exporter -service-name "SERVICE_NAME" -service-uri "REMOTE_HOST" -service-port REMOTE_PORT -service-metrics-path "REMOTE_PATH"
+./json-stats-exporter -service-name "SERVICE_NAME" -service-uri "REMOTE_HOST" -service-port REMOTE_PORT -service-metrics-path "REMOTE_PATH"
 ```
 
 ## TODO