Track eth-docker version in metrics (#2662)

* export eth-docker version

* Scope Alloy Docker discovery to this install's own Compose project

* update comment

* Read eth-docker version from README.md instead of nearest git tag

* add COMPOSE_PROJECT_NAME to .env and bump version

* Move version metric out of ./.eth into ./prometheus

* Make Alloy project-name scoping opt-in via ALLOY_FILTER_BY_PROJECT_NAME

Replace the automatic COMPOSE_PROJECT_NAME pinning with an opt-in boolean.
The old approach hijacked Compose's own COMPOSE_PROJECT_NAME and set it for
everyone, risking broken volume references and changing the default
scrape-all behavior.

ALLOY_FILTER_BY_PROJECT_NAME (default false) now leaves collection
unchanged. When true, ethd resolves this install's project name read-only
via `docker compose config` and writes it to ALLOY_PROJECT_NAME, which
config.alloy uses to scope Docker discovery. Alloy has no conditional
expressions, so the decision is made in ethd and coalesced to ".*" when
empty. COMPOSE_PROJECT_NAME is never touched.

Also drop the version-metric write from start(); it belongs only in
update(), where the version can actually change.

* pr comments: read env var into __value, use ${__project_name}

* Read NODE_EXPORTER_COLLECTOR_MOUNT_PATH into __value, not a local

* Update ethd

* Update ethd

* Update ethd

* Update ethd

---------

Co-authored-by: erl-100 <erl-100>
Co-authored-by: Yorick Downe <71337066+yorickdowne@users.noreply.github.com>

Author: erl-100

alloy/config.alloy

@@ -11,6 +11,18 @@ discovery.docker "docker_containers" {
 discovery.relabel "docker_logs" {
   targets = discovery.docker.docker_containers.targets
 
+  // discovery.docker sees every container on the host, not just this
+  // project's. ALLOY_PROJECT_NAME holds this install's Compose project name
+  // when ALLOY_FILTER_BY_PROJECT_NAME=true (ethd resolves and sets it); we
+  // then keep only our own, so multiple Eth Docker installs on one host don't
+  // ship each other's logs. Empty (the default) coalesces to ".*", matching
+  // every container on the host and preserving the scrape-all behavior.
+  rule {
+    source_labels = ["__meta_docker_container_label_com_docker_compose_project"]
+    regex         = coalesce(sys.env("ALLOY_PROJECT_NAME"), ".*")
+    action        = "keep"
+  }
+
  rule {
     source_labels = ["__meta_docker_container_label_logs_collect"]
     regex         = "true"
@@ -37,6 +49,18 @@ loki.source.docker "docker_logs" {
 discovery.relabel "docker_metrics" {
   targets = discovery.docker.docker_containers.targets
 
+  // discovery.docker sees every container on the host, not just this
+  // project's. ALLOY_PROJECT_NAME holds this install's Compose project name
+  // when ALLOY_FILTER_BY_PROJECT_NAME=true (ethd resolves and sets it); we
+  // then keep only our own, so multiple Eth Docker installs on one host don't
+  // scrape/ship each other's metrics. Empty (the default) coalesces to ".*",
+  // matching every container on the host and preserving the scrape-all behavior.
+  rule {
+    source_labels = ["__meta_docker_container_label_com_docker_compose_project"]
+    regex         = coalesce(sys.env("ALLOY_PROJECT_NAME"), ".*")
+    action        = "keep"
+  }
+
   rule {
     source_labels = ["__meta_docker_container_label_metrics_scrape"]
     regex         = "true"

default.env

@@ -562,10 +562,14 @@ DDNS_TAG=v2
 NODE_EXPORTER_COLLECTOR_MOUNT_PATH=
 # For the Node Dashboard, define a regex of mount points to ignore for the diskspace check.
 NODE_EXPORTER_IGNORE_MOUNT_REGEX='^/(dev|proc|sys|run|var/snap/.+|var/lib/docker.+)($|/)'
+# Set true to scope Alloy collection to this install's own containers, needed for a correct Eth Docker version metric when running multiple instances on one host. false scrapes every container
+ALLOY_FILTER_BY_PROJECT_NAME=false
 # And the Docker root so promtail scrapes logs from the right location. This is updated by ethd
 DOCKER_ROOT=/var/lib/docker
 # Docker socket location. Updated by ethd on Ubuntu/Debian; on macOS set to <home-dir>/.colima/default/docker.sock if using Colima
 DOCKER_SOCK=/var/run/docker.sock
+# This install's Compose project name, resolved by ethd when ALLOY_FILTER_BY_PROJECT_NAME is true. Updated by ethd - do not set by hand
+ALLOY_PROJECT_NAME=
 
 # Used by ethd update - please do not adjust
-ENV_VERSION=61
+ENV_VERSION=62

ethd

@@ -2698,6 +2698,8 @@ reset to defaults."
     echo "Please make sure to run compatible client versions."
   fi
 
+  __write_eth_docker_version_metric
+
   if [[ ! "$OSTYPE" = "darwin"* ]]; then
 # Release lock and remove lock file
     exec 200<&-
@@ -4322,12 +4324,69 @@ __adjust_grandine_permissions() {
 }
 
 
+# Writes the currently checked-out Eth Docker version as a node-exporter
+# textfile-collector metric (see grafana.yml), so it can be tracked the same
+# way the EL/CL client versions already are. "tag" comes from README.md's
+# "This is Eth Docker vX.Y.Z" line (the same source `version` reads). A
+# release commit bumps that line straight to "vX.Y.Z-dev" for the next
+# version, so this stays accurate on main between releases. Writes into
+# the same host directory node-exporter's textfile collector is already
+# mounted from (NODE_EXPORTER_COLLECTOR_MOUNT_PATH, defaulting to
+# ./prometheus/node-exporter-text) - that mount is read-only inside the
+# container, so the file has to land there from the host side.
+__write_eth_docker_version_metric() {
+  local tag
+  local commit
+  local var
+  local textfile_dir
+
+  tag=$(grep -m1 "^This is ${__project_name} v" README.md 2>/dev/null | sed -E "s/^This is ${__project_name} //") || tag=""
+  commit=$(${__as_owner} git rev-parse --short HEAD 2>/dev/null) || commit=""
+
+  var=NODE_EXPORTER_COLLECTOR_MOUNT_PATH
+  __get_value_from_env "${var}" "${__env_file}" "__value"
+  textfile_dir="${__value:-./prometheus/node-exporter-text}"
+
+  ${__as_owner} mkdir -p "${textfile_dir}"
+  {
+    echo "# HELP eth_docker_version_info Currently checked out ${__project_name} version"
+    echo "# TYPE eth_docker_version_info gauge"
+    echo "eth_docker_version_info{tag=\"${tag}\",commit=\"${commit}\"} 1"
+  } | ${__as_owner} tee "${textfile_dir}/eth-docker-version.prom.tmp" >/dev/null
+  ${__as_owner} mv "${textfile_dir}/eth-docker-version.prom.tmp" "${textfile_dir}/eth-docker-version.prom"
+}
+
+
+# Sets ALLOY_PROJECT_NAME in .env so config.alloy can scope Alloy's Docker
+# service discovery to this install's own containers (see grafana.yml). When
+# ALLOY_FILTER_BY_PROJECT_NAME is true, the name is read back from Compose's
+# own resolution (docker compose config), never computed independently and
+# never written to COMPOSE_PROJECT_NAME. Otherwise it is cleared, and Alloy
+# coalesces the empty value to ".*" - the scrape-all default. Runs on every
+# start so toggling ALLOY_FILTER_BY_PROJECT_NAME takes effect on the next up.
+__set_alloy_project_name() {
+  local var
+
+  var=ALLOY_FILTER_BY_PROJECT_NAME
+  __get_value_from_env "${var}" "${__env_file}" "__value"
+  if [[ "${__value}" = "true" ]]; then
+    ALLOY_PROJECT_NAME=$(__docompose config 2>/dev/null | awk -F': ' '/^name:/{print $2; exit}') || ALLOY_PROJECT_NAME=""
+  else
+    ALLOY_PROJECT_NAME=""
+  fi
+
+  var=ALLOY_PROJECT_NAME
+  __update_value_in_env "${var}" "${!var}" "${__env_file}"
+}
+
+
 upgrade() {
   update
 }
 
 
 start() {
+  __set_alloy_project_name
   __adjust_grandine_permissions
   __docompose up -d --remove-orphans "$@"
 }

grafana-cloud.yml

@@ -52,7 +52,7 @@ services:
       - /sys:/host/sys:ro,rslave
       - /etc/hostname:/etc/nodename:ro
       - /etc/localtime:/etc/localtime:ro
-      - ${NODE_EXPORTER_COLLECTOR_MOUNT_PATH:-/tmp/dummy-nodeexp-text}:/tmp/text-collector:ro
+      - ${NODE_EXPORTER_COLLECTOR_MOUNT_PATH:-./prometheus/node-exporter-text}:/tmp/text-collector:ro
     <<: *logging
     labels:
       - metrics.scrape=true
@@ -120,6 +120,8 @@ services:
   alloy:
     image: grafana/alloy:latest
     restart: unless-stopped
+    environment:
+      - ALLOY_PROJECT_NAME=${ALLOY_PROJECT_NAME:-}
     volumes:
       - alloy-data:/var/lib/alloy
       - ./alloy:/etc/alloy

grafana-rootless.yml

@@ -94,6 +94,8 @@ services:
   alloy:
     image: grafana/alloy:latest
     restart: unless-stopped
+    environment:
+      - ALLOY_PROJECT_NAME=${ALLOY_PROJECT_NAME:-}
     volumes:
       - alloy-data:/var/lib/alloy
       - ./alloy:/etc/alloy

grafana.yml

@@ -75,7 +75,7 @@ services:
       - /sys:/host/sys:ro,rslave
       - /etc/hostname:/etc/nodename:ro
       - /etc/localtime:/etc/localtime:ro
-      - ${NODE_EXPORTER_COLLECTOR_MOUNT_PATH:-/tmp/dummy-nodeexp-text}:/tmp/text-collector:ro
+      - ${NODE_EXPORTER_COLLECTOR_MOUNT_PATH:-./prometheus/node-exporter-text}:/tmp/text-collector:ro
     command:
       - '--path.rootfs=/rootfs'
       - '--path.sysfs=/host/sys'
@@ -151,6 +151,8 @@ services:
   alloy:
     image: grafana/alloy:latest
     restart: unless-stopped
+    environment:
+      - ALLOY_PROJECT_NAME=${ALLOY_PROJECT_NAME:-}
     volumes:
       - alloy-data:/var/lib/alloy
       - ./alloy:/etc/alloy

prometheus/.gitignore

@@ -2,3 +2,5 @@
 prometheus.yml
 custom-prom.yml
 conf.d
+# node-exporter textfile-collector metrics written by ethd
+node-exporter-text