v0.3.0

What's Changed

Breaking change

Configuration file

The exporter used to connect to the Kopia API server with one fixed identity configured through three top-level keys:

kopia:
  password: "<password>"
  apiserver:
    repositoryURL: "https://some.url:port"
    hostname: "<hostname>"
    username: "<username>"
    fingerprint: "<fingerprint>"

Those keys are no longer read. Configuration now lives under kopia.clients, a map of named clients. The exporter connects to the API server once per client and exposes per-host metrics (the server only returns each client its own snapshots):

kopia:
  apiserver:
    repositoryURL: "https://some.url:port"
    fingerprint: "<fingerprint>"
  clients:
    default:
      username: "<username>"
      hostname: "<hostname>"
      password: "<password>"
    # add as many clients as you need
    otherhost:
      username: "<username>"
      hostname: "<hostname>"
      password: "<password>"

The name of a client (default, otherhost, ...) is arbitrary and is only used as the map key. Everything else stays the same: exporter, filters and logger sections are unchanged.

Environment variables

Environment variables change accordingly:

• Removed: KGE_KOPIA_PASSWORD, KGE_KOPIA_APISERVER_HOSTNAME, KGE_KOPIA_APISERVER_USERNAME
• Added per client, with <NAME> replaced by the client name (e.g. KGE_KOPIA_CLIENTS_DEFAULT_PASSWORD for the default client):
  • KGE_KOPIA_CLIENTS_<NAME>_PASSWORD
  • KGE_KOPIA_CLIENTS_<NAME>_HOSTNAME
  • KGE_KOPIA_CLIENTS_<NAME>_USERNAME
• Unchanged: KGE_KOPIA_APISERVER_FINGERPRINT, KGE_KOPIA_APISERVER_REPOSITORYURL

Changes

• feat: support multiple kopia client identities by @ymettier in #29
• chore: bump go dependencies and CI actions by @ymettier in #30
• docs: filter release badge on version and add helm release badge by @ymettier in #31
• refactor: deduplicate Kopia client construction and simplify filters by @ymettier in #32
• Prepare release v0.3.0-rc1 by @ymettier in #33
• docs: fix release process and revert pre-release version references by @ymettier in #35
• Prepare release v0.3.0 by @ymettier in #40

Full Changelog: v0.2.0...v0.3.0

kopia-go-exporter 0.3.0

Helm chart version: 0.3.0

Install:

helm upgrade --install --rollback-on-failure kopia-go-exporter oci://ghcr.io/ymettier/charts/kopia-go-exporter --version 0.3.0 -f myvalues.yaml

Breaking change since 0.2.0

• Client credentials moved from kopia.apiserver.{username,hostname} to a kopia.clients.<name>.{username,hostname} map.
• The injected password env var is now per client (KGE_KOPIA_CLIENTS_<NAME>_PASSWORD instead of the hardcoded
  KGE_KOPIA_PASSWORD).
• The Secret (kopiaConfigSecret) must contain a password-<clientname> key per client (e.g. password-default); the fingerprint key is unchanged.

kopia-go-exporter 0.3.0-rc3

Helm chart version: 0.3.0-rc3

Install:

helm upgrade --install --rollback-on-failure kopia-go-exporter oci://ghcr.io/ymettier/charts/kopia-go-exporter --version 0.3.0-rc3 -f myvalues.yaml

Breaking change since 0.2.0

• Client credentials moved from kopia.apiserver.{username,hostname} to a kopia.clients.<name>.{username,hostname} map.
• The injected password env var is now per client (KGE_KOPIA_CLIENTS_<NAME>_PASSWORD instead of the hardcoded
  KGE_KOPIA_PASSWORD).
• The Secret (kopiaConfigSecret) must contain a password-<clientname> key per client (e.g. password-default); the fingerprint key is unchanged.

kopia-go-exporter 0.3.0-rc2

Helm chart version: 0.3.0-rc2

Install:

helm upgrade --install --rollback-on-failure kopia-go-exporter oci://ghcr.io/ymettier/charts/kopia-go-exporter --version 0.3.0-rc2 -f myvalues.yaml

Breaking change

• kopiaConfigSecret is removed from values.yaml. Existing deployments must set config.kopia.clients.<name>.passwordSecretName (Secret with a password key) and config.kopia.apiserver.fingerprintSecretName (Secret with a fingerprint key) instead.

kopia-go-exporter 0.3.0-rc1

Helm chart version: 0.3.0-rc1

Install:

helm upgrade --install --rollback-on-failure kopia-go-exporter oci://ghcr.io/ymettier/charts/kopia-go-exporter --version 0.3.0-rc1 -f myvalues.yaml

v0.3.0-rc1

What's Changed

Breaking change

The exporter used to connect to the Kopia API server with one fixed identity configured through three top-level keys:

kopia:
  password: "<password>"
  apiserver:
    repositoryURL: "https://some.url:port"
    hostname: "<hostname>"
    username: "<username>"
    fingerprint: "<fingerprint>"

Those keys are no longer read. Configuration now lives under kopia.clients, a map of named clients. The exporter connects to the API server once per client and exposes per-host metrics (the server only returns each client its own snapshots):

kopia:
  apiserver:
    repositoryURL: "https://some.url:port"
    fingerprint: "<fingerprint>"
  clients:
    default:
      username: "<username>"
      hostname: "<hostname>"
      password: "<password>"
    # add as many clients as you need
    otherhost:
      username: "<username>"
      hostname: "<hostname>"
      password: "<password>"

The name of a client (default, otherhost, ...) is arbitrary and is only used as the map key. Everything else stays the same: exporter, filters and logger sections are unchanged.

Changes

• feat: support multiple kopia client identities by @ymettier in #29
• chore: bump go dependencies and CI actions by @ymettier in #30
• docs: filter release badge on version and add helm release badge by @ymettier in #31
• refactor: deduplicate Kopia client construction and simplify filters by @ymettier in #32
• Prepare release v0.3.0-rc1 by @ymettier in #33

Full Changelog: helm-v0.2.0...v0.3.0-rc1

v0.2.0

Breaking change

Configuration for logging to filename changed.

logger:
  maxsize: 100          # max size in MB before rotation
  maxbackups: 3         # max number of old log files to keep
  maxage: 28            # max number of days to retain old log files
  compress: false       # compress rotated files with gzip

becomes

logger:
  log_file:
    maxsize: 100          # max size in MB before rotation
    maxbackups: 3         # max number of old log files to keep
    maxage: 28            # max number of days to retain old log files
    compress: false       # compress rotated files with gzip

What's Changed

Changes

• docs: fix release workflow VERSION and add helm chart release section by @ymettier in #22
• feat: add kopia_go_exporter_up metric for connection status by @ymettier in #23
• Remove Docker image footer from GoReleaser config by @ymettier in #24
• Prepare release v0.2.0-rc3 by @ymettier in #25
• test: strengthen assertions in exporter and logger tests by @ymettier in #18
• Embed config.default.yaml as defaults and detect un-overridden placeholders by @ymettier in #19
• Misc improvements: config redesign, test hardening, and bug fixes by @ymettier in #20
• Prepare release v0.2.0-rc2 by @ymettier in #21
• ci: add helm chart release support by @ymettier in #14
• feat: add include/exclude regex path filters for snapshot metrics by @ymettier in #15
• test: cover run() edge branches and raise coverage thresholds by @ymettier in #16
• Prepare release 0.2.0-rc1 by @ymettier in #17

Full Changelog: helm-v0.1.0...v0.2.0

---

Released by GoReleaser.

kopia-go-exporter 0.2.0

Helm chart version: 0.2.0

Install:

helm upgrade --install --rollback-on-failure kopia-go-exporter oci://ghcr.io/ymettier/charts/kopia-go-exporter --version 0.2.0 -f myvalues.yaml

v0.2.0-rc3

What's Changed

Changes

• docs: fix release workflow VERSION and add helm chart release section by @ymettier in #22
• feat: add kopia_go_exporter_up metric for connection status by @ymettier in #23
• Remove Docker image footer from GoReleaser config by @ymettier in #24
• Prepare release v0.2.0-rc3 by @ymettier in #25

Full Changelog: v0.2.0-rc2...v0.2.0-rc3

v0.2.0-rc2

Breaking change

Configuration for logging to filename changed.

logger:
  maxsize: 100          # max size in MB before rotation
  maxbackups: 3         # max number of old log files to keep
  maxage: 28            # max number of days to retain old log files
  compress: false       # compress rotated files with gzip

becomes

logger:
  log_file:
    maxsize: 100          # max size in MB before rotation
    maxbackups: 3         # max number of old log files to keep
    maxage: 28            # max number of days to retain old log files
    compress: false       # compress rotated files with gzip

What's Changed

Changes

• test: strengthen assertions in exporter and logger tests by @ymettier in #18
• Embed config.default.yaml as defaults and detect un-overridden placeholders by @ymettier in #19
• Misc improvements: config redesign, test hardening, and bug fixes by @ymettier in #20
• Prepare release v0.2.0-rc2 by @ymettier in #21

Full Changelog: v0.2.0-rc1...v0.2.0-rc2

---

Released by GoReleaser.