Update exporter boilerplate

Use Prometheus common / exporter-toolkit boilerplate.
* Update Prometheus synced files.
* Fixup linter errors.

Signed-off-by: SuperQ <superq@gmail.com>

.github/workflows/golangci-lint.yml

@@ -1,3 +1,5 @@
+---
+# This action is synced from https://github.com/prometheus/prometheus
 name: golangci-lint
 on:
   push:
@@ -10,21 +12,28 @@ on:
       - ".golangci.yml"
   pull_request:
 
+permissions:  # added using https://github.com/step-security/secure-repo
+  contents: read
+
 jobs:
   golangci:
+    permissions:
+      contents: read  # for actions/checkout to fetch code
+      pull-requests: read  # for golangci/golangci-lint-action to fetch pull requests
     name: lint
     runs-on: ubuntu-latest
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
-      - name: install Go
-        uses: actions/setup-go@v3
+        uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4.2.0
+      - name: Install Go
+        uses: actions/setup-go@0a12ed9d6a96ab950c8f026ed9f722fe0da7ef32 # v5.0.2
         with:
-          go-version: 1.20.x
+          go-version: 1.23.x
       - name: Install snmp_exporter/generator dependencies
         run: sudo apt-get update && sudo apt-get -y install libsnmp-dev
         if: github.repository == 'prometheus/snmp_exporter'
       - name: Lint
-        uses: golangci/golangci-lint-action@v3.4.0
+        uses: golangci/golangci-lint-action@aaa42aa0628b4ae2578232a66b541047968fac86 # v6.1.0
         with:
-          version: v1.51.2
+          args: --verbose
+          version: v1.60.2

.golangci.yml

@@ -0,0 +1,24 @@
+---
+linters:
+  enable:
+    - misspell
+    - revive
+    - sloglint
+
+issues:
+  exclude-rules:
+    - path: _test.go
+      linters:
+        - errcheck
+
+linters-settings:
+  errcheck:
+    exclude-functions:
+      # Used in HTTP handlers, any error is handled by the server itself.
+      - (net/http.ResponseWriter).Write
+  revive:
+    rules:
+      # https://github.com/mgechev/revive/blob/master/RULES_DESCRIPTIONS.md#unused-parameter
+      - name: unused-parameter
+        severity: warning
+        disabled: true

Makefile.common

@@ -49,23 +49,23 @@ endif
 GOTEST := $(GO) test
 GOTEST_DIR :=
 ifneq ($(CIRCLE_JOB),)
-ifneq ($(shell command -v gotestsum > /dev/null),)
+ifneq ($(shell command -v gotestsum 2> /dev/null),)
 	GOTEST_DIR := test-results
 	GOTEST := gotestsum --junitfile $(GOTEST_DIR)/unit-tests.xml --
 endif
 endif
 
-PROMU_VERSION ?= 0.14.0
+PROMU_VERSION ?= 0.17.0
 PROMU_URL     := https://github.com/prometheus/promu/releases/download/v$(PROMU_VERSION)/promu-$(PROMU_VERSION).$(GO_BUILD_PLATFORM).tar.gz
 
 SKIP_GOLANGCI_LINT :=
 GOLANGCI_LINT :=
 GOLANGCI_LINT_OPTS ?=
-GOLANGCI_LINT_VERSION ?= v1.53.3
-# golangci-lint only supports linux, darwin and windows platforms on i386/amd64.
+GOLANGCI_LINT_VERSION ?= v1.60.2
+# golangci-lint only supports linux, darwin and windows platforms on i386/amd64/arm64.
 # windows isn't included here because of the path separator being different.
 ifeq ($(GOHOSTOS),$(filter $(GOHOSTOS),linux darwin))
-	ifeq ($(GOHOSTARCH),$(filter $(GOHOSTARCH),amd64 i386))
+	ifeq ($(GOHOSTARCH),$(filter $(GOHOSTARCH),amd64 i386 arm64))
 		# If we're in CI and there is an Actions file, that means the linter
 		# is being run in Actions, so we don't need to run it here.
 		ifneq (,$(SKIP_GOLANGCI_LINT))
@@ -169,16 +169,20 @@ common-vet:
 common-lint: $(GOLANGCI_LINT)
 ifdef GOLANGCI_LINT
 	@echo ">> running golangci-lint"
-# 'go list' needs to be executed before staticcheck to prepopulate the modules cache.
-# Otherwise staticcheck might fail randomly for some reason not yet explained.
-	$(GO) list -e -compiled -test=true -export=false -deps=true -find=false -tags= -- ./... > /dev/null
 	$(GOLANGCI_LINT) run $(GOLANGCI_LINT_OPTS) $(pkgs)
 endif
 
+.PHONY: common-lint-fix
+common-lint-fix: $(GOLANGCI_LINT)
+ifdef GOLANGCI_LINT
+	@echo ">> running golangci-lint fix"
+	$(GOLANGCI_LINT) run --fix $(GOLANGCI_LINT_OPTS) $(pkgs)
+endif
+
 .PHONY: common-yamllint
 common-yamllint:
 	@echo ">> running yamllint on all YAML files in the repository"
-ifeq (, $(shell command -v yamllint > /dev/null))
+ifeq (, $(shell command -v yamllint 2> /dev/null))
 	@echo "yamllint not installed so skipping"
 else
 	yamllint .
@@ -204,6 +208,10 @@ common-tarball: promu
 	@echo ">> building release tarball"
 	$(PROMU) tarball --prefix $(PREFIX) $(BIN_DIR)
 
+.PHONY: common-docker-repo-name
+common-docker-repo-name:
+	@echo "$(DOCKER_REPO)/$(DOCKER_IMAGE_NAME)"
+
 .PHONY: common-docker $(BUILD_DOCKER_ARCHS)
 common-docker: $(BUILD_DOCKER_ARCHS)
 $(BUILD_DOCKER_ARCHS): common-docker-%:
@@ -267,3 +275,9 @@ $(1)_precheck:
 		exit 1; \
 	fi
 endef
+
+govulncheck: install-govulncheck
+	govulncheck ./...
+
+install-govulncheck:
+	command -v govulncheck > /dev/null || go install golang.org/x/vuln/cmd/govulncheck@latest

README.md

@@ -58,16 +58,16 @@ ecs_memory_limit_bytes{container="ecs-metadata-proxy"} 9.223372036854772e+18
 # HELP ecs_memory_max_bytes Maximum memory usage in bytes.
 # TYPE ecs_memory_max_bytes gauge
 ecs_memory_max_bytes{container="ecs-metadata-proxy"} 9.023488e+06
-# HELP ecs_network_receive_bytes_total Network recieved in bytes.
+# HELP ecs_network_receive_bytes_total Network received in bytes.
 # TYPE ecs_network_receive_bytes_total counter
 ecs_network_receive_bytes_total{container="ecs-metadata-proxy",device="eth1"} 4.2851757e+07
-# HELP ecs_network_receive_dropped_total Network packets dropped in recieving.
+# HELP ecs_network_receive_dropped_total Network packets dropped in receiving.
 # TYPE ecs_network_receive_dropped_total counter
 ecs_network_receive_dropped_total{container="ecs-metadata-proxy",device="eth1"} 0
-# HELP ecs_network_receive_errors_total Network errors in recieving.
+# HELP ecs_network_receive_errors_total Network errors in receiving.
 # TYPE ecs_network_receive_errors_total counter
 ecs_network_receive_errors_total{container="ecs-metadata-proxy",device="eth1"} 0
-# HELP ecs_network_receive_packets_total Network packets recieved.
+# HELP ecs_network_receive_packets_total Network packets received.
 # TYPE ecs_network_receive_packets_total counter
 ecs_network_receive_packets_total{container="ecs-metadata-proxy",device="eth1"} 516239
 # HELP ecs_network_transmit_bytes_total Network transmitted in bytes.

ecscollector/collector.go

@@ -35,7 +35,7 @@ var (
 		"ECS service metadata.",
 		metadataLabels, nil)
 
-	svcCpuLimitDesc = prometheus.NewDesc(
+	svcCPULimitDesc = prometheus.NewDesc(
 		"ecs_svc_cpu_limit",
 		"Total CPU Limit.",
 		svcLabels, nil)
@@ -67,22 +67,22 @@ var (
 
 	networkRxBytesDesc = prometheus.NewDesc(
 		"ecs_network_receive_bytes_total",
-		"Network recieved in bytes.",
+		"Network received in bytes.",
 		networkLabels, nil)
 
 	networkRxPacketsDesc = prometheus.NewDesc(
 		"ecs_network_receive_packets_total",
-		"Network packets recieved.",
+		"Network packets received.",
 		networkLabels, nil)
 
 	networkRxDroppedDesc = prometheus.NewDesc(
 		"ecs_network_receive_dropped_total",
-		"Network packets dropped in recieving.",
+		"Network packets dropped in receiving.",
 		networkLabels, nil)
 
 	networkRxErrorsDesc = prometheus.NewDesc(
 		"ecs_network_receive_errors_total",
-		"Network errors in recieving.",
+		"Network errors in receiving.",
 		networkLabels, nil)
 
 	networkTxBytesDesc = prometheus.NewDesc(
@@ -191,7 +191,7 @@ func (c *collector) Collect(ch chan<- prometheus.Metric) {
 	if metadata.Limits != nil {
 		if metadata.Limits.CPU != nil {
 			ch <- prometheus.MustNewConstMetric(
-				svcCpuLimitDesc,
+				svcCPULimitDesc,
 				prometheus.GaugeValue,
 				*metadata.Limits.CPU,
 				metadata.TaskARN,

go.mod

@@ -3,30 +3,45 @@ module github.com/prometheus-community/ecs_exporter
 go 1.22
 
 require (
+	github.com/alecthomas/kingpin/v2 v2.4.0
 	github.com/aws/amazon-ecs-agent/ecs-agent v0.0.0-20240920192628-cf8c7a6b6504
-	github.com/prometheus/client_golang v1.15.1
+	github.com/prometheus/client_golang v1.20.4
+	github.com/prometheus/common v0.60.0
+	github.com/prometheus/exporter-toolkit v0.13.0
 )
 
 require (
+	github.com/alecthomas/units v0.0.0-20211218093645-b94a6e3cc137 // indirect
 	github.com/aws/aws-sdk-go v1.51.3 // indirect
 	github.com/beorn7/perks v1.0.1 // indirect
-	github.com/cespare/xxhash/v2 v2.2.0 // indirect
+	github.com/cespare/xxhash/v2 v2.3.0 // indirect
 	github.com/cihub/seelog v0.0.0-20170130134532-f561c5e57575 // indirect
+	github.com/coreos/go-systemd/v22 v22.5.0 // indirect
 	github.com/docker/docker v24.0.9+incompatible // indirect
 	github.com/docker/go-connections v0.4.0 // indirect
 	github.com/docker/go-units v0.5.0 // indirect
 	github.com/gogo/protobuf v1.3.2 // indirect
-	github.com/golang/protobuf v1.5.4 // indirect
 	github.com/gorilla/mux v1.8.0 // indirect
 	github.com/jmespath/go-jmespath v0.4.0 // indirect
-	github.com/matttproud/golang_protobuf_extensions v1.0.4 // indirect
+	github.com/jpillora/backoff v1.0.0 // indirect
+	github.com/klauspost/compress v1.17.9 // indirect
+	github.com/mdlayher/socket v0.4.1 // indirect
+	github.com/mdlayher/vsock v1.2.1 // indirect
+	github.com/munnerz/goautoneg v0.0.0-20191010083416-a7dc8b61c822 // indirect
+	github.com/mwitkow/go-conntrack v0.0.0-20190716064945-2f068394615f // indirect
 	github.com/opencontainers/go-digest v1.0.0 // indirect
 	github.com/opencontainers/image-spec v1.1.0-rc3 // indirect
 	github.com/pkg/errors v0.9.1 // indirect
-	github.com/prometheus/client_model v0.3.0 // indirect
-	github.com/prometheus/common v0.42.0 // indirect
-	github.com/prometheus/procfs v0.9.0 // indirect
+	github.com/prometheus/client_model v0.6.1 // indirect
+	github.com/prometheus/procfs v0.15.1 // indirect
+	github.com/xhit/go-str2duration/v2 v2.1.0 // indirect
+	golang.org/x/crypto v0.27.0 // indirect
 	golang.org/x/exp v0.0.0-20231006140011-7918f672742d // indirect
+	golang.org/x/net v0.29.0 // indirect
+	golang.org/x/oauth2 v0.23.0 // indirect
+	golang.org/x/sync v0.8.0 // indirect
 	golang.org/x/sys v0.25.0 // indirect
-	google.golang.org/protobuf v1.33.0 // indirect
+	golang.org/x/text v0.18.0 // indirect
+	google.golang.org/protobuf v1.34.2 // indirect
+	gopkg.in/yaml.v2 v2.4.0 // indirect
 )