Merge pull request #2 from cea-hpc/rebase_020

Rebase on v0.20

Author: fihuer

.github/workflows/go.yml

@@ -1 +1,3 @@
 bin/
+go/
+*.snap

.gitignore

@@ -0,0 +1,64 @@
+## Changelog
+
+Full commit history per tag: https://github.com/vpenso/prometheus-slurm-exporter/commits/{tag number}
+
+* **0.19**
+  - Merge PR#50
+
+* **0.18**
+  - Add CPU/Memory info per node (see PR#47)
+
+* **0.17**
+  - Add fair share collector
+
+* **0.16**
+  - Export more data per account/partition, fix squeue for pending jobs
+  - Merge PR#34
+
+* **0.15**
+  - CPU allocation status per partition
+
+* **0.14**
+  - add stats about jobs per account/per user
+
+* **0.13**
+  - Merge pull request #32 from pdtpartners/faster-node-metrics
+
+* **0.12**
+  - Merge pull request #30 from omnivector-solutions/add_snap_packaging
+
+* **0.11**
+  - Merge PR#29
+  - Add more backfill stats (see PR#27)
+
+* **0.10**
+  - Scheduler: keep track of the DBD agent queue size
+
+* **0.9**
+  - README: update to fix build problem raised with issue #26
+
+* **0.8**
+  - Merge pull request #21 from cleargray/command-paths
+
+* **0.7**
+  - Update scheduler.go (fix issue #18)
+
+* **0.6**
+  - Merge pull request #13 from rug-cit-hpc/master
+
+* **0.5**
+  - [BUG]: count all job states (issue #9)
+
+* **0.4**
+  - Merge pull request #8 from MatMaul/pending-dep
+
+* **0.3**
+  - Fix issue #4
+
+* **0.2**
+  - Fix issue #3
+
+* **0.1** 
+  - Basic prototype
+  - Merge PR#2
+  - Add Grafana dashboard

CHANGELOG.md

@@ -0,0 +1,56 @@
+# Development
+
+Setup the development environment on a node with access to the Slurm user
+command-line interface, in particular with the `sinfo`, `squeue`, and `sdiag`
+commands.
+
+## Install Go from source
+
+```bash
+export VERSION=1.15 OS=linux ARCH=amd64
+wget https://dl.google.com/go/go$VERSION.$OS-$ARCH.tar.gz
+tar -xzvf go$VERSION.$OS-$ARCH.tar.gz
+export PATH=$PWD/go/bin:$PATH
+```
+
+_Alternatively install Go using the packaging system of your Linux distribution._
+
+## Clone this repository and build
+
+Use Git to clone the source code of the exporter, run all the tests and build the binary:
+
+```bash
+# clone the source code
+git clone https://github.com/vpenso/prometheus-slurm-exporter.git
+cd prometheus-slurm-exporter
+make
+```
+
+To just run the tests:
+
+```bash
+make test
+```
+
+Start the exporter (foreground), and query all metrics:
+
+```bash
+./bin/prometheus-slurm-exporter
+```
+
+If you wish to run the exporter on a different port, or the default port (8080) is already in use, run with the following argument:
+
+```bash
+./bin/prometheus-slurm-exporter --listen-address="0.0.0.0:<port>"
+...
+
+# query all metrics (default port)
+curl http://localhost:8080/metrics
+```
+
+## References
+
+* [GOlang Package Documentation](https://godoc.org/github.com/prometheus/client_golang/prometheus)
+* [Metric Types](https://prometheus.io/docs/concepts/metric_types/)
+* [Writing Exporters](https://prometheus.io/docs/instrumenting/writing_exporters/)
+* [Available Exporters](https://prometheus.io/docs/instrumenting/exporters/)

CONTRIBUTORS.md

@@ -1,20 +1,28 @@
 PROJECT_NAME = prometheus-slurm-exporter
-ifndef GOPATH
-	GOPATH=$(shell pwd):/usr/share/gocode
-endif
-GOFILES=cpus.go main.go nodes.go queue.go scheduler.go
-GOBIN=bin/$(PROJECT_NAME)
+SHELL := $(shell which bash) -eu -o pipefail
 
-build:
-	mkdir -p $(shell pwd)/bin
-	@echo "Build $(GOFILES) to $(GOBIN)"
-	@GOPATH=$(GOPATH) go build -o $(GOBIN) $(GOFILES)
+GOPATH := $(shell pwd)/go/modules
+GOBIN := bin/$(PROJECT_NAME)
+GOFILES := $(shell ls *.go)
 
-test:
-	@GOPATH=$(GOPATH) go test -v *.go
+.PHONY: build
+build: test $(GOBIN)
 
-run:
-	@GOPATH=$(GOPATH) go run $(GOFILES)
+$(GOBIN): go/modules/pkg/mod $(GOFILES)
+	mkdir -p bin
+	@echo "Building $(GOBIN)"
+	go build -v -o $(GOBIN)
+
+go/modules/pkg/mod: go.mod
+	go mod download
+
+.PHONY: test
+test: go/modules/pkg/mod $(GOFILES)
+	go test -v
+
+run: $(GOBIN)
+	$(GOBIN)
 
 clean:
-	if [ -f ${GOBIN} ] ; then rm -f ${GOBIN} ; fi
+	go clean -modcache
+	rm -fr bin/ go/