feat(dashmate): add prometheus service discovery labels

packages/dashmate/docker-compose.rate_limiter.metrics.yml

@@ -12,6 +12,10 @@ services:
     image: ${PLATFORM_GATEWAY_RATE_LIMITER_METRICS_DOCKER_IMAGE:?err}
     labels:
       org.dashmate.service.title: "Gateway rate limiter metrics exporter"
+      org.dashmate.config.name: "${CONFIG_NAME:?err}"
+      prometheus.io/scrape: "${PLATFORM_GATEWAY_RATE_LIMITER_METRICS_ENABLED:-false}"
+      prometheus.io/port: "${PLATFORM_GATEWAY_RATE_LIMITER_METRICS_PORT:?err}"
+      prometheus.io/path: "/metrics"
     restart: unless-stopped
     logging: *default-logging
     entrypoint: /bin/statsd_exporter

packages/dashmate/docker-compose.yml

@@ -54,6 +54,10 @@ services:
     image: ${PLATFORM_DRIVE_ABCI_DOCKER_IMAGE:?err}
     labels:
       org.dashmate.service.title: "Drive ABCI"
+      org.dashmate.config.name: "${CONFIG_NAME:?err}"
+      prometheus.io/scrape: "${PLATFORM_DRIVE_ABCI_METRICS_ENABLED:-false}"
+      prometheus.io/port: "${PLATFORM_DRIVE_ABCI_METRICS_PORT:?err}"
+      prometheus.io/path: "/metrics"
     restart: unless-stopped
     logging: *default-logging
     volumes:
@@ -111,6 +115,10 @@ services:
     image: ${PLATFORM_DRIVE_TENDERDASH_DOCKER_IMAGE:?err}
     labels:
       org.dashmate.service.title: "Drive Tenderdash"
+      org.dashmate.config.name: "${CONFIG_NAME:?err}"
+      prometheus.io/scrape: "${PLATFORM_DRIVE_TENDERDASH_METRICS_ENABLED:-false}"
+      prometheus.io/port: "${PLATFORM_DRIVE_TENDERDASH_METRICS_PORT:?err}"
+      prometheus.io/path: "/metrics"
     restart: unless-stopped
     logging: *default-logging
     depends_on:
@@ -196,6 +204,10 @@ services:
     image: ${PLATFORM_DAPI_RS_DAPI_DOCKER_IMAGE:?err}
     labels:
       org.dashmate.service.title: "rs-dapi (Rust DAPI)"
+      org.dashmate.config.name: "${CONFIG_NAME:?err}"
+      prometheus.io/scrape:  "${PLATFORM_DAPI_RS_DAPI_METRICS_ENABLED:-false}"
+      prometheus.io/port: "${PLATFORM_DAPI_RS_DAPI_METRICS_PORT:?err}"
+      prometheus.io/path: "/metrics"
     restart: unless-stopped
     logging: *default-logging
     deploy:
@@ -236,6 +248,10 @@ services:
     image: ${PLATFORM_GATEWAY_DOCKER_IMAGE:?err}
     labels:
       org.dashmate.service.title: "Gateway"
+      org.dashmate.config.name: "${CONFIG_NAME:?err}"
+      prometheus.io/scrape: "${PLATFORM_GATEWAY_METRICS_ENABLED:-false}"
+      prometheus.io/port: "${PLATFORM_GATEWAY_METRICS_PORT:?err}"
+      prometheus.io/path: "/metrics"
     restart: unless-stopped
     logging: *default-logging
     ports:

packages/dashmate/docs/config/gateway.md

@@ -54,7 +54,7 @@ These settings control the metrics endpoint for monitoring the Gateway:
 | `platform.gateway.metrics.port` | Port for metrics server | `9090` | `9091` |
 
 Metrics provide performance and health information about the Gateway service.
-Admin must be enabled to access the metrics endpoint.
+Dashmate automatically enables the Envoy admin endpoint whenever metrics are enabled so that the Prometheus listener can proxy `/stats/prometheus`; if admin itself is still disabled, the listener is not exposed outside of Docker.
 
 ## Admin
 

packages/dashmate/docs/services/gateway.md

@@ -261,7 +261,7 @@ Metrics include:
 - Host: `platform.gateway.metrics.host` (default: 127.0.0.1)
 - Port: `platform.gateway.metrics.port` (default: 9090)
 
-**Note:** admin interface must be enabled too.
+**Note:** Dashmate automatically enables the Envoy admin endpoint whenever metrics are turned on so the Prometheus listener can proxy `/stats/prometheus`. If the admin service remains disabled, this socket is not exposed outside Docker; once you explicitly enable admin, it uses the host you configure.
 
 ### Security Considerations
 

packages/dashmate/docs/services/index.md

@@ -119,3 +119,4 @@ Most services provide metrics endpoints:
 - Rate Limiter: Rate limiting metrics
 
 These can be integrated with monitoring systems like Prometheus and Grafana.
+All containers that expose Prometheus metrics also advertise the Docker label `org.dashmate.config.name`, which Dashmate sets to the active config name. When you run multiple nodes on the same host, you can use that label in Prometheus relabeling rules or dashboards to distinguish each instance.

packages/dashmate/src/doctor/analyse/analyseConfigFactory.js

@@ -16,17 +16,6 @@ export default function analyseConfigFactory() {
     const problems = [];
 
     if (config?.get('platform.enable')) {
-      // Gateway admin is disabled while metrics are enabled
-      if (config.get('platform.gateway.metrics.enabled') && !config.get('platform.gateway.admin.enabled')) {
-        const problem = new Problem(
-          'Gateway admin is disabled while metrics are enabled',
-          chalk`Please enable gateway admin: {bold.cyanBright dashmate config set platform.gateway.admin.enabled true}`,
-          SEVERITY.HIGH,
-        );
-
-        problems.push(problem);
-      }
-
       // Platform Node ID
       const masternodeStatus = samples.getServiceInfo('core', 'masternodeStatus');
       const platformNodeId = masternodeStatus?.dmnState?.platformNodeId;

packages/dashmate/templates/dynamic-compose.yml.dot

@@ -39,8 +39,6 @@ services:
     {{? it.platform.dapi.rsDapi.metrics.enabled }}
     ports:
       - {{=it.platform.dapi.rsDapi.metrics.host}}:{{=it.platform.dapi.rsDapi.metrics.port}}:{{=it.platform.dapi.rsDapi.metrics.port}}
-    {{??}}
-    ports: []
     {{?}}
   {{?}}
 

packages/dashmate/templates/platform/gateway/envoy.yaml.dot

@@ -527,7 +527,7 @@ static_resources:
                       address: gateway_rate_limiter
                       port_value: 8081
     {{?}}
-    {{? it.platform.gateway.metrics.enabled && it.platform.gateway.admin.enabled }}
+    {{? it.platform.gateway.metrics.enabled }}
     - name: admin
       connect_timeout: 0.25s
       type: STATIC
@@ -542,11 +542,12 @@ static_resources:
                     port_value: 9901
     {{?}}
 
-{{? it.platform.gateway.admin.enabled }}
+{{? it.platform.gateway.admin.enabled || it.platform.gateway.metrics.enabled }}
+{{ adminHost = it.platform.gateway.admin.enabled ? '0.0.0.0' : '127.0.0.1'; }}
 admin:
  address:
    socket_address:
-     address: 0.0.0.0 # For docker container only. Must be a local/private interface.
+     address: {{= adminHost }} # defaults to loopback when not explicitly enabled
      port_value: 9901
 {{?}}
 

packages/dashmate/test/unit/templates/dynamicCompose.spec.js

@@ -0,0 +1,44 @@
+import HomeDir from '../../../src/config/HomeDir.js';
+import getBaseConfigFactory from '../../../configs/defaults/getBaseConfigFactory.js';
+import renderTemplateFactory from '../../../src/templates/renderTemplateFactory.js';
+import renderServiceTemplatesFactory from '../../../src/templates/renderServiceTemplatesFactory.js';
+
+function getRsDapiBlock(dynamicComposeContent) {
+  const match = dynamicComposeContent.match(/rs_dapi:\n((?: {2}.*\n)+)/);
+  return match ? match[1] : '';
+}
+
+describe('dynamic compose template', () => {
+  let getBaseConfig;
+  let renderServiceTemplates;
+
+  beforeEach(() => {
+    getBaseConfig = getBaseConfigFactory(HomeDir.createTemp());
+    const renderTemplate = renderTemplateFactory();
+    renderServiceTemplates = renderServiceTemplatesFactory(renderTemplate);
+  });
+
+  it('should not publish metrics port when rs-dapi metrics are disabled', () => {
+    const config = getBaseConfig();
+
+    const renderedConfigs = renderServiceTemplates(config);
+    const rsDapiBlock = getRsDapiBlock(renderedConfigs['dynamic-compose.yml']);
+
+    expect(rsDapiBlock).to.not.include('ports:');
+    expect(rsDapiBlock).to.not.include(':0');
+  });
+
+  it('should publish metrics port when rs-dapi metrics are enabled', () => {
+    const config = getBaseConfig();
+
+    config.set('platform.dapi.rsDapi.metrics.enabled', true);
+    config.set('platform.dapi.rsDapi.metrics.port', 29091);
+    config.set('platform.dapi.rsDapi.metrics.host', '127.0.0.1');
+
+    const renderedConfigs = renderServiceTemplates(config);
+    const rsDapiBlock = getRsDapiBlock(renderedConfigs['dynamic-compose.yml']);
+
+    expect(rsDapiBlock).to.include('ports:\n      - 127.0.0.1:29091:29091');
+    expect(rsDapiBlock).to.include('- 29091');
+  });
+});

packages/dashmate/test/unit/templates/envoyTemplate.spec.js

@@ -0,0 +1,24 @@
+import getBaseConfigFactory from '../../../configs/defaults/getBaseConfigFactory.js';
+import HomeDir from '../../../src/config/HomeDir.js';
+import renderServiceTemplatesFactory from '../../../src/templates/renderServiceTemplatesFactory.js';
+import renderTemplateFactory from '../../../src/templates/renderTemplateFactory.js';
+
+describe('envoy template', () => {
+  it('should render admin interface when metrics are enabled even if admin is disabled', () => {
+    const getBaseConfig = getBaseConfigFactory(HomeDir.createTemp());
+    const config = getBaseConfig();
+
+    config.set('platform.gateway.metrics.enabled', true);
+    config.set('platform.gateway.admin.enabled', false);
+
+    const renderTemplate = renderTemplateFactory();
+    const renderServiceTemplates = renderServiceTemplatesFactory(renderTemplate);
+    const renderedConfigs = renderServiceTemplates(config);
+
+    const envoyConfig = renderedConfigs['platform/gateway/envoy.yaml'];
+
+    expect(envoyConfig).to.include('cluster_name: admin');
+    expect(envoyConfig).to.include('address: 127.0.0.1');
+    expect(envoyConfig).to.include('port_value: 9901');
+  });
+});