Merge pull request #12 from natrontech/feat/update-go

feat: bump go to v1.22, update dependencies & workflow

.github/dependabot.yml

@@ -0,0 +1,15 @@
+version: 2
+updates:
+  - package-ecosystem: "gomod" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: ":robot:"
+  # GitHub Actions
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "weekly"
+    commit-message:
+      prefix: ":seedling:"

.github/workflows/ci.yml

@@ -13,17 +13,17 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        goVer: [1.21]
+        goVer: [1.22]
 
     steps:
     - name: Set up Go ${{ matrix.goVer }}
-      uses: actions/setup-go@v1
+      uses: actions/setup-go@v4
       with:
         go-version: ${{ matrix.goVer }}
       id: go
 
     - name: Check out code into the Go module directory
-      uses: actions/checkout@v2
+      uses: actions/checkout@v4
 
     - name: Get dependencies
       run: |

.github/workflows/codeql.yml

@@ -40,11 +40,11 @@ jobs:
 
     steps:
     - name: Checkout repository
-      uses: actions/checkout@v3
+      uses: actions/checkout@v4
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -58,7 +58,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, Go, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -71,6 +71,6 @@ jobs:
     #     ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/docker-release.yml

@@ -17,23 +17,23 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Log in to the Container registry
-        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        uses: docker/login-action@v3
         with:
           registry: ${{ env.REGISTRY }}
           username: ${{ github.actor }}
           password: ${{ secrets.GITHUB_TOKEN }}
 
       - name: Extract metadata (tags, labels) for Docker
         id: meta
-        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        uses: docker/metadata-action@v5
         with:
           images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
 
       - name: Build and push Docker image
-        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        uses: docker/build-push-action@v5
         with:
           context: .
           push: true

.pre-commit-config.yaml

@@ -1,7 +1,7 @@
 ---
 repos:
   - repo: https://github.com/pre-commit/pre-commit-hooks.git
-    rev: v4.4.0
+    rev: v4.6.0
     hooks:
       - id: end-of-file-fixer
         exclude_types: ['markdown']
@@ -12,7 +12,7 @@ repos:
       - id: check-executables-have-shebangs
       - id: check-merge-conflict
   - repo: https://github.com/gitleaks/gitleaks
-    rev: v8.17.0
+    rev: v8.18.2
     hooks:
       - id: gitleaks
   - repo: https://github.com/dnephin/pre-commit-golang

CODE_OF_CONDUCT.md

@@ -0,0 +1,128 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[email protected].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+<https://www.contributor-covenant.org/version/2/0/code_of_conduct.html>.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+<https://www.contributor-covenant.org/faq>. Translations are available at
+<https://www.contributor-covenant.org/translations>.

CONTRIBUTING.md

@@ -0,0 +1,17 @@
+# Contributing
+
+When contributing to this repository, please first discuss the change you wish to make via issue,
+email, or any other method with the owners of this repository before making a change. 
+
+Please note we have a code of conduct, please follow it in all your interactions with the project.
+
+## Pull Request Process
+
+1. Ensure any install or build dependencies are removed before the end of the layer when doing a 
+   build.
+2. Update the README.md with details of changes to the interface, this includes new environment 
+   variables, exposed ports, useful file locations and container parameters.
+3. Increase the version numbers in any examples files and the README.md to the new version that this
+   Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/).
+4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 
+   do not have permission to do that, you may request the second reviewer to merge it for you.

Dockerfile

@@ -1,10 +1,20 @@
-FROM golang:1.21-alpine AS builder
+FROM golang:1.22-alpine AS builder
 WORKDIR /build
 COPY go.mod go.sum main.go ./
 RUN go mod tidy \
   && CGO_ENABLED=0 go build
 
-FROM alpine as runtime
-COPY --from=builder /build/pbs-exporter /app/pbs-exporter
-EXPOSE 9101
-CMD ["/app/pbs-exporter"]
+FROM alpine:3.19 as runtime
+
+LABEL maintainer="natrontech"
+
+RUN addgroup -S app \
+    && adduser -S -G app app
+
+WORKDIR /home/app
+COPY --from=builder /build/pbs-exporter .
+RUN chown -R app:app ./
+
+USER app
+
+CMD ["./pbs-exporter"]

README.md

@@ -19,31 +19,31 @@ Metrics are retrieved using the [Proxmox Backup Server API](https://pbs.proxmox.
 
 ## Exported Metrics
 
-| Metric | Meaning | Labels |
-| ------ | ------- | ------ |
-| pbs_up | Was the last query of Proxmox Backup Server successful? | |
-| pbs_available | The available bytes of the underlying storage. | `datastore` |
-| pbs_size | The size of the underlying storage in bytes. | `datastore` |
-| pbs_used | The used bytes of the underlying storage. | `datastore` |
-| pbs_snapshot_count | The total number of backups. | `datastore`, `namespace` |
-| pbs_snapshot_vm_count | The total number of backups per VM. | `datastore`, `namespace`, `vm_id`, `vm_name` |
-| pbs_snapshot_vm_last_timestamp | The timestamp of the last backup of a VM. | `datastore`, `namespace`, `vm_id`, `vm_name` |
-| pbs_snapshot_vm_last_verify | The verify status of the last backup of a VM. | `datastore`, `namespace`, `vm_id`, `vm_name` |
-| pbs_host_cpu_usage | The CPU usage of the host. | |
-| pbs_host_memory_free | The free memory of the host. | |
-| pbs_host_memory_total | The total memory of the host. | |
-| pbs_host_memory_used | The used memory of the host. | |
-| pbs_host_swap_free | The free swap of the host. | |
-| pbs_host_swap_total | The total swap of the host. | |
-| pbs_host_swap_used | The used swap of the host. | |
-| pbs_host_disk_available | The available disk of the local root disk in bytes. | |
-| pbs_host_disk_total | The total disk of the local root disk in bytes. | |
-| pbs_host_disk_used | The used disk of the local root disk in bytes. | |
-| pbs_host_uptime | The uptime of the host. | |
-| pbs_host_io_wait | The io wait of the host. | |
-| pbs_host_load1 | The load for 1 minute of the host. | |
-| pbs_host_load5 | The load for 5 minutes of the host. | |
-| pbs_host_load15 | The load 15 minutes of the host. | |
+| Metric                         | Meaning                                                 | Labels                                       |
+| ------------------------------ | ------------------------------------------------------- | -------------------------------------------- |
+| pbs_up                         | Was the last query of Proxmox Backup Server successful? |                                              |
+| pbs_available                  | The available bytes of the underlying storage.          | `datastore`                                  |
+| pbs_size                       | The size of the underlying storage in bytes.            | `datastore`                                  |
+| pbs_used                       | The used bytes of the underlying storage.               | `datastore`                                  |
+| pbs_snapshot_count             | The total number of backups.                            | `datastore`, `namespace`                     |
+| pbs_snapshot_vm_count          | The total number of backups per VM.                     | `datastore`, `namespace`, `vm_id`, `vm_name` |
+| pbs_snapshot_vm_last_timestamp | The timestamp of the last backup of a VM.               | `datastore`, `namespace`, `vm_id`, `vm_name` |
+| pbs_snapshot_vm_last_verify    | The verify status of the last backup of a VM.           | `datastore`, `namespace`, `vm_id`, `vm_name` |
+| pbs_host_cpu_usage             | The CPU usage of the host.                              |                                              |
+| pbs_host_memory_free           | The free memory of the host.                            |                                              |
+| pbs_host_memory_total          | The total memory of the host.                           |                                              |
+| pbs_host_memory_used           | The used memory of the host.                            |                                              |
+| pbs_host_swap_free             | The free swap of the host.                              |                                              |
+| pbs_host_swap_total            | The total swap of the host.                             |                                              |
+| pbs_host_swap_used             | The used swap of the host.                              |                                              |
+| pbs_host_disk_available        | The available disk of the local root disk in bytes.     |                                              |
+| pbs_host_disk_total            | The total disk of the local root disk in bytes.         |                                              |
+| pbs_host_disk_used             | The used disk of the local root disk in bytes.          |                                              |
+| pbs_host_uptime                | The uptime of the host.                                 |                                              |
+| pbs_host_io_wait               | The io wait of the host.                                |                                              |
+| pbs_host_load1                 | The load for 1 minute of the host.                      |                                              |
+| pbs_host_load5                 | The load for 5 minutes of the host.                     |                                              |
+| pbs_host_load15                | The load 15 minutes of the host.                        |                                              |
 
 ## Flags / Environment Variables
 
@@ -53,18 +53,18 @@ $ ./pbs-exporter -help
 
 You can use the following flags to configure the exporter. All flags can also be set using environment variables. Environment variables take precedence over flags.
 
-| Flag | Environment Variable | Description | Default |
-| ---- | -------------------- | ----------- | ------- |
-| `pbs.loglevl` | `PBS_LOGLEVEL` | Log level (debug, info) | `info` |
-| `pbs.api.token` | `PBS_API_TOKEN` | API token to use for authentication | |
-| `pbs.api.token.name` | `PBS_API_TOKEN_NAME` | Name of the API token to use for authentication | `pbs-exporter` |
-| `pbs.endpoint` | `PBS_ENDPOINT` | Address of the Proxmox Backup Server | `http://localhost:8007` |
-| `pbs.username` | `PBS_USERNAME` | Username to use for authentication | `root@pam` |
-| `pbs.timeout` | `PBS_TIMEOUT` | Timeout for requests to Proxmox Backup Server | `5s` |
-| `pbs.insecure` | `PBS_INSECURE` | Disable TLS certificate verification | `false` |
-| `pbs.metrics-path` | `PBS_METRICS_PATH` | Path under which to expose metrics | `/metrics` |
-| `pbs.web.listen-address` | `PBS_LISTEN_ADDRESS` | Address to listen on for web interface and telemetry | `:9101` |
+| Flag                     | Environment Variable | Description                                          | Default                 |
+| ------------------------ | -------------------- | ---------------------------------------------------- | ----------------------- |
+| `pbs.loglevl`            | `PBS_LOGLEVEL`       | Log level (debug, info)                              | `info`                  |
+| `pbs.api.token`          | `PBS_API_TOKEN`      | API token to use for authentication                  |                         |
+| `pbs.api.token.name`     | `PBS_API_TOKEN_NAME` | Name of the API token to use for authentication      | `pbs-exporter`          |
+| `pbs.endpoint`           | `PBS_ENDPOINT`       | Address of the Proxmox Backup Server                 | `http://localhost:8007` |
+| `pbs.username`           | `PBS_USERNAME`       | Username to use for authentication                   | `root@pam`              |
+| `pbs.timeout`            | `PBS_TIMEOUT`        | Timeout for requests to Proxmox Backup Server        | `5s`                    |
+| `pbs.insecure`           | `PBS_INSECURE`       | Disable TLS certificate verification                 | `false`                 |
+| `pbs.metrics-path`       | `PBS_METRICS_PATH`   | Path under which to expose metrics                   | `/metrics`              |
+| `pbs.web.listen-address` | `PBS_LISTEN_ADDRESS` | Address to listen on for web interface and telemetry | `:9101`                 |
 
 ## Node metrics
 
-According to the [api documentation](https://pbs.proxmox.com/docs/api-viewer/index.html#/nodes/{node}), we have to provide a node name (won't work with the node ip), but it seems to work with any name, so we just use "localhost" for the request. This setup is tested with one proxmox backup server host.
+According to the [api documentation](https://pbs.proxmox.com/docs/api-viewer/index.html#/nodes/{node}), we have to provide a node name (won't work with the node ip), but it seems to work with any name, so we just use "localhost" for the request. This setup is tested with one proxmox backup server host.

SECURITY.md

@@ -0,0 +1,11 @@
+# Security Policy
+
+## Supported Versions
+
+| Version | Supported          |
+| ------- | ------------------ |
+| latest  | :white_check_mark: |
+
+## Reporting a Vulnerability
+
+Open up an issue :)