HYPHAby S33D
Documentation › Integrations

Software exposing Prometheus: Consul, Vault, Traefik, Kafka, GitLab, Argo CD…

Twenty-nine ready-made profiles for the agent's OpenMetrics reader: one configuration line per product, clean metric names, monitor templates and a catalog dashboard for each.

At a glance

Each product is read by the agent's OpenMetrics reader with a profile that sets the port, the path, the families kept, their HYPHA names and the labels kept. The profiles were written against the expositions of the real products, run in containers in an S33D test environment (versions in the last column).

ProductProfileDefault addressNamespaceTested on
HashiCorp Consulconsulhttp://127.0.0.1:8500/v1/agent/metrics?format=prometheusconsul.*Consul 2.1.0
HashiCorp Vaultvaulthttps://127.0.0.1:8200/v1/sys/metrics?format=prometheusvault.*Vault 2.2.2
etcdetcdhttp://127.0.0.1:2379/metricsetcd.*etcd 3.6.5
CoreDNScorednshttp://127.0.0.1:9153/metricscoredns.*CoreDNS 1.12.4
Traefik Proxytraefikhttp://127.0.0.1:8080/metricstraefik.*Traefik 3.7.19
Envoy Proxyenvoyhttp://127.0.0.1:9901/stats/prometheusenvoy.*Envoy 1.36.13
Kong Gatewaykonghttp://127.0.0.1:8100/metricskong.*Kong 3.9.4
CockroachDBcockroachdbhttps://127.0.0.1:8080/_status/varscockroachdb.*CockroachDB 26.4.1
ScyllaDBscyllahttp://127.0.0.1:9180/metricsscylla.*ScyllaDB 2026.3.6
Apache Pulsarpulsarhttp://127.0.0.1:8080/metrics/pulsar.*Pulsar 5.0.1 (standalone)
Celery (through Flower)celeryhttp://127.0.0.1:5555/metricscelery.*Celery 5.7.0, Flower 2.2.0
n8nn8nhttp://127.0.0.1:5678/metricsn8n.*n8n 2.48.6
Temporaltemporalhttp://127.0.0.1:9090/metricstemporal.*Temporal 1.32.2
GitLab (Rails, Puma)gitlabhttp://127.0.0.1:8080/-/metricsgitlab.*GitLab CE 19.6.1
GitLab (Sidekiq)gitlab_sidekiqhttp://127.0.0.1:8082/metricsgitlab_sidekiq.*GitLab CE 19.6.1
GitLab (Gitaly)gitalyhttp://127.0.0.1:9236/metricsgitaly.*GitLab CE 19.6.1
SonarQubesonarqubehttp://127.0.0.1:9000/api/monitoring/metricssonarqube.*Community Build 26.11
Apache Solrsolrhttp://127.0.0.1:8983/solr/admin/metrics?wt=prometheussolr.*Solr 10.1.0 and 9.11.0
WildFlywildflyhttp://127.0.0.1:9990/metricswildfly.*WildFly 42.0.0
Apache Tomcattomcathttp://127.0.0.1:9404/metrics (JMX exporter)tomcat.*Tomcat 11.0.29
Apache Kafkakafkahttp://127.0.0.1:9405/metrics (JMX exporter)kafka.*Kafka 4.3.1 (KRaft)
Apache ActiveMQ Classicactivemqhttp://127.0.0.1:9406/metrics (JMX exporter)activemq.*ActiveMQ 6.2.0
Apache Cassandracassandrahttp://127.0.0.1:9407/metrics (JMX exporter)cassandra.*Cassandra 5.0.9
cert-managercert_managerhttp://127.0.0.1:9402/metricscert_manager.*cert-manager 1.21.3 (k3s 1.35)
Velerovelerohttp://127.0.0.1:8085/metricsvelero.*Velero 1.18.2 (k3s 1.35)
Argo CD (controller)argocdhttp://127.0.0.1:8082/metricsargocd.*Argo CD 3.6.2 (k3s 1.35)
Argo CD (repositories)argocd_repo_serverhttp://127.0.0.1:8084/metricsargocd_repo_server.*Argo CD 3.6.2 (k3s 1.35)
Linkerd (proxy)linkerdhttp://127.0.0.1:4191/metricslinkerd.*Linkerd edge-26.11.2 (k3s 1.35)
KEDAkedahttp://127.0.0.1:8080/metricskeda.*KEDA 2.21.1 (k3s 1.35)

"Tested" means the product ran in a container, the agent read it and produced the names described here. A few families documented by the vendor but absent during the test (they only appear after their event) are kept and pointed out below.

Declaring a product

One entry per product in integrations.openmetrics:

integrations:
  openmetrics:
    - profile: consul                       # default address from the table above
    - profile: traefik
      url: http://127.0.0.1:8082            # no path: the profile's path is added
    - profile: vault
      url: https://vault.lan:8200           # ?format=prometheus is added too
      ca_file: /etc/hypha/vault-ca.pem
      bearer_token_file: /etc/hypha/vault-metrics.token
    - profile: kafka
      name: kafka-1                         # two brokers on one machine: one name each
    - profile: kafka
      name: kafka-2
      url: http://127.0.0.1:9415

Infrastructure

HashiCorp Consul

In the Consul agent configuration: telemetry { prometheus_retention_time = "60s" disable_hostname = true } (without a retention time the response is empty). With ACLs, an agent:read token (bearer_token_file).

Consul does not publish the status of its health checks in Prometheus format.

HashiCorp Vault

In the Vault configuration: telemetry { prometheus_retention_time = "60s" disable_hostname = true }. No token needed if the listener has telemetry { unauthenticated_metrics_access = true }, otherwise a token whose policy reads sys/metrics (bearer_token_file). The profile targets HTTPS, like a production Vault.

etcd

Client port 2379, or the --listen-metrics-urls address (http://127.0.0.1:2381 with kubeadm).

Network

CoreDNS

prometheus :9153 plugin in the Corefile.

Traefik Proxy

--metrics.prometheus=true; the traefik entry point (8080) serves the metrics, or the one set by --metrics.prometheus.entryPoint. Router and service labels with addRoutersLabels and addServicesLabels.

Envoy Proxy

Admin interface (admin, 9901), path /stats/prometheus. Durations in milliseconds.

Kong Gateway

prometheus plugin enabled (globally or per service; status_code_metrics, latency_metrics, bandwidth_metrics, upstream_health_metrics set to true), read on the status listener (status_listen = 0.0.0.0:8100) or the Admin API. Latencies in milliseconds.

Databases

CockroachDB

/_status/vars on the HTTP port (8080), over HTTPS unless --insecure (ca_file pointing at the cluster CA), no authentication. The exposition is large (≈ 1.8 MB): interval: 30s is enough. Latencies in nanoseconds.

ScyllaDB

/metrics on port 9180. Series are summed over all cores (the shard label is dropped); coordinator latencies in microseconds.

Message queues

Apache Pulsar

The broker's /metrics/ (HTTP port 8080). Broker and per-Pulsar-namespace aggregates: the topic label is dropped, so one more topic does not mean one more series.

Celery (through Flower)

Flower publishes the workers' metrics on /metrics (5555). Workers must send their events (celery worker -E, or worker_send_task_events = True).

Applications

n8n

N8N_METRICS=true. Workflow executions with N8N_METRICS_INCLUDE_MESSAGE_EVENT_BUS_METRICS=true, per workflow with N8N_METRICS_INCLUDE_WORKFLOW_ID_LABEL=true.

Temporal

The server's global.metrics.prometheus.listenAddress (9090 in the Helm chart, 8000 in the Docker examples: adjust url). Durations in seconds.

GitLab

Three profiles for an Omnibus installation, read by the agent on the GitLab machine:

Metrics:

The test ran with reduced settings (Puma in single mode, 5 Sidekiq threads, bundled Prometheus off); the profile applies to the default configuration as well.

SonarQube

/api/monitoring/metrics (SonarQube 9.3 and later), read with the system passcode header (sonar.web.systemPasscode) or an administrator token:

    - profile: sonarqube
      headers:
        X-Sonar-Passcode: "the passcode"   # configuration file in mode 600

Java

The Prometheus JMX exporter

Tomcat, Kafka, ActiveMQ and Cassandra do not publish Prometheus metrics: their JMX MBeans are read by the official Prometheus JMX exporter, loaded as a javaagent in the JVM. Download jmx_prometheus_javaagent-1.7.0.jar from the releases of the prometheus/jmx_exporter project on GitHub (the SHA-256 sum is published next to it; Maven Central stops at 1.0.1), put the product's rules file (below) next to it, then add to the JVM:

-javaagent:/opt/jmx/jmx_prometheus_javaagent-1.7.0.jar=127.0.0.1:9404:/opt/jmx/tomcat.yml

127.0.0.1: before the port keeps the exporter on the loopback. Each profile also keeps the JVM metrics published by the exporter: <namespace>.jvm.memory.used, .memory.committed, .memory.max (area: heap, nonheap), <namespace>.jvm.gc.collection (.count, .sum), .jvm.threads.current, .jvm.threads.deadlocked, .jvm.classes.loaded, <namespace>.process.cpu_seconds, .process.open_fds, <namespace>.jmx.scrape_error (1 = unreadable MBeans), .jmx.scrape_duration.

The rules restrict the MBeans read (includeObjectNames): a full scrape of Kafka or Cassandra is costly for the JVM and yields thousands of series.

Apache Tomcat

In bin/setenv.sh: CATALINA_OPTS="$CATALINA_OPTS -javaagent:/opt/jmx/jmx_prometheus_javaagent-1.7.0.jar=127.0.0.1:9404:/opt/jmx/tomcat.yml".

# HYPHA rules for Apache Tomcat (Prometheus JMX exporter, javaagent 1.x).
lowercaseOutputName: true
lowercaseOutputLabelNames: true
includeObjectNames:
  - "Catalina:type=GlobalRequestProcessor,*"
  - "Catalina:type=ThreadPool,*"
  - "Catalina:type=Manager,*"
rules:
  - pattern: 'Catalina<type=GlobalRequestProcessor, name="?([^",>]+)"?><>(requestCount|errorCount|bytesReceived|bytesSent|processingTime):'
    name: tomcat_requestprocessor_$2_total
    labels:
      connector: "$1"
    type: COUNTER
  - pattern: 'Catalina<type=GlobalRequestProcessor, name="?([^",>]+)"?><>maxTime:'
    name: tomcat_requestprocessor_maxtime
    labels:
      connector: "$1"
    type: GAUGE
  - pattern: 'Catalina<type=ThreadPool, name="?([^",>]+)"?><>(currentThreadCount|currentThreadsBusy|maxThreads|connectionCount|maxConnections):'
    name: tomcat_threadpool_$2
    labels:
      connector: "$1"
    type: GAUGE
  - pattern: 'Catalina<type=Manager, host=([^,>]+), context=([^,>]+)><>(activeSessions|maxActiveSessions):'
    name: tomcat_session_$3
    labels:
      vhost: "$1"
      context: "$2"
    type: GAUGE
  - pattern: 'Catalina<type=Manager, host=([^,>]+), context=([^,>]+)><>(rejectedSessions|expiredSessions|sessionCounter):'
    name: tomcat_session_$3_total
    labels:
      vhost: "$1"
      context: "$2"
    type: COUNTER

Apache Kafka

KAFKA_OPTS="-javaagent:/opt/jmx/jmx_prometheus_javaagent-1.7.0.jar=127.0.0.1:9405:/opt/jmx/kafka.yml" before starting the broker. Kafka's tools (kafka-*.sh) also read KAFKA_OPTS: run them with an empty KAFKA_OPTS=, otherwise they grab the exporter's port.

# HYPHA rules for Apache Kafka 3.x/4.x (KRaft or ZooKeeper), Prometheus JMX exporter 1.x.
lowercaseOutputName: true
lowercaseOutputLabelNames: true
includeObjectNames:
  - "kafka.server:type=BrokerTopicMetrics,*"
  - "kafka.server:type=ReplicaManager,*"
  - "kafka.server:type=KafkaRequestHandlerPool,*"
  - "kafka.controller:type=KafkaController,*"
  - "kafka.controller:type=ControllerStats,*"
  - "kafka.network:type=RequestMetrics,name=TotalTimeMs,*"
  - "kafka.network:type=RequestMetrics,name=RequestsPerSec,*"
  - "kafka.network:type=SocketServer,*"
  - "kafka.log:type=LogFlushStats,*"
rules:
  - pattern: 'kafka.server<type=BrokerTopicMetrics, name=(MessagesInPerSec|BytesInPerSec|BytesOutPerSec|BytesRejectedPerSec|FailedProduceRequestsPerSec|FailedFetchRequestsPerSec|TotalProduceRequestsPerSec|TotalFetchRequestsPerSec)><>Count:'
    name: kafka_server_brokertopicmetrics_$1_total
    type: COUNTER
  - pattern: 'kafka.server<type=ReplicaManager, name=(UnderReplicatedPartitions|UnderMinIsrPartitionCount|AtMinIsrPartitionCount|OfflineReplicaCount|PartitionCount|LeaderCount)><>Value:'
    name: kafka_server_replicamanager_$1
    type: GAUGE
  - pattern: 'kafka.server<type=ReplicaManager, name=(IsrShrinksPerSec|IsrExpandsPerSec)><>Count:'
    name: kafka_server_replicamanager_$1_total
    type: COUNTER
  - pattern: 'kafka.server<type=KafkaRequestHandlerPool, name=RequestHandlerAvgIdlePercent><>OneMinuteRate:'
    name: kafka_server_requesthandler_avg_idle_percent
    type: GAUGE
  - pattern: 'kafka.controller<type=KafkaController, name=(ActiveControllerCount|OfflinePartitionsCount|GlobalTopicCount|GlobalPartitionCount|PreferredReplicaImbalanceCount|ActiveBrokerCount|FencedBrokerCount)><>Value:'
    name: kafka_controller_$1
    type: GAUGE
  - pattern: 'kafka.controller<type=ControllerStats, name=(UncleanLeaderElectionsPerSec|LeaderElectionRateAndTimeMs)><>Count:'
    name: kafka_controller_stats_$1_total
    type: COUNTER
  - pattern: 'kafka.network<type=RequestMetrics, name=TotalTimeMs, request=(Produce|FetchConsumer|FetchFollower|Metadata|OffsetCommit)><>(Mean|99thPercentile):'
    name: kafka_network_request_totaltimems_$2
    labels:
      request: "$1"
    type: GAUGE
  - pattern: 'kafka.network<type=RequestMetrics, name=RequestsPerSec, request=(Produce|FetchConsumer|FetchFollower|Metadata|OffsetCommit), version=(\d+)><>Count:'
    name: kafka_network_requests_total
    labels:
      request: "$1"
      version: "$2"
    type: COUNTER
  - pattern: 'kafka.network<type=SocketServer, name=NetworkProcessorAvgIdlePercent><>Value:'
    name: kafka_network_processor_avg_idle_percent
    type: GAUGE
  - pattern: 'kafka.log<type=LogFlushStats, name=LogFlushRateAndTimeMs><>Count:'
    name: kafka_log_flushes_total
    type: COUNTER
  - pattern: 'kafka.log<type=LogFlushStats, name=LogFlushRateAndTimeMs><>99thPercentile:'
    name: kafka_log_flush_time_ms_p99
    type: GAUGE

Consumer lag is read at the consumers, not in the broker.

Apache ActiveMQ Classic

ACTIVEMQ_OPTS (in bin/setenv or the environment): the value replaces the script's, so keep the memory and login settings, for example -Xms64M -Xmx1G -Djava.util.logging.config.file=logging.properties -Djava.security.auth.login.config=$ACTIVEMQ_CONF/login.config -javaagent:/opt/jmx/jmx_prometheus_javaagent-1.7.0.jar=127.0.0.1:9406:/opt/jmx/activemq.yml. The activemq producer, consumer… commands also read ACTIVEMQ_OPTS: give them a value without the javaagent.

# HYPHA rules for Apache ActiveMQ Classic 5.x/6.x (Prometheus JMX exporter 1.x). The internal
# advisory destinations (ActiveMQ.Advisory.*) are left out.
lowercaseOutputName: true
lowercaseOutputLabelNames: true
includeObjectNames:
  - "org.apache.activemq:type=Broker,brokerName=*"
  - "org.apache.activemq:type=Broker,brokerName=*,destinationType=*,destinationName=*"
rules:
  - pattern: 'org.apache.activemq<type=Broker, brokerName=([^,>]+), destinationType=(Queue|Topic), destinationName=((?!ActiveMQ\.Advisory)[^,>]+)><>(QueueSize|ConsumerCount|ProducerCount|InFlightCount|MemoryPercentUsage|AverageEnqueueTime):'
    name: activemq_destination_$4
    labels:
      broker: "$1"
      destination_type: "$2"
      destination: "$3"
    type: GAUGE
  - pattern: 'org.apache.activemq<type=Broker, brokerName=([^,>]+), destinationType=(Queue|Topic), destinationName=((?!ActiveMQ\.Advisory)[^,>]+)><>(EnqueueCount|DequeueCount|ExpiredCount|DispatchCount):'
    name: activemq_destination_$4_total
    labels:
      broker: "$1"
      destination_type: "$2"
      destination: "$3"
    type: COUNTER
  - pattern: 'org.apache.activemq<type=Broker, brokerName=([^,>]+)><>(MemoryPercentUsage|StorePercentUsage|TempPercentUsage|CurrentConnectionsCount|TotalConsumerCount|TotalProducerCount|TotalMessageCount):'
    name: activemq_broker_$2
    labels:
      broker: "$1"
    type: GAUGE
  - pattern: 'org.apache.activemq<type=Broker, brokerName=([^,>]+)><>(TotalEnqueueCount|TotalDequeueCount):'
    name: activemq_broker_$2_total
    labels:
      broker: "$1"
    type: COUNTER

Apache Cassandra

JVM_EXTRA_OPTS="-javaagent:/opt/jmx/jmx_prometheus_javaagent-1.7.0.jar=127.0.0.1:9407:/opt/jmx/cassandra.yml" (read by cassandra-env.sh). Client request latencies in microseconds.

# HYPHA rules for Apache Cassandra 4.x/5.x (Prometheus JMX exporter 1.x). Client request
# latencies in microseconds (Cassandra timers).
lowercaseOutputName: true
lowercaseOutputLabelNames: true
includeObjectNames:
  - "org.apache.cassandra.metrics:type=ClientRequest,*"
  - "org.apache.cassandra.metrics:type=Storage,*"
  - "org.apache.cassandra.metrics:type=Compaction,*"
  - "org.apache.cassandra.metrics:type=ThreadPools,*"
  - "org.apache.cassandra.metrics:type=DroppedMessage,*"
  - "org.apache.cassandra.metrics:type=Client,*"
  - "org.apache.cassandra.metrics:type=Cache,*"
  - "org.apache.cassandra.metrics:type=CommitLog,*"
rules:
  - pattern: 'org.apache.cassandra.metrics<type=ClientRequest, scope=(Read|Write|CASRead|CASWrite|RangeSlice), name=Latency><>Count:'
    name: cassandra_clientrequest_requests_total
    labels:
      scope: "$1"
    type: COUNTER
  - pattern: 'org.apache.cassandra.metrics<type=ClientRequest, scope=(Read|Write|CASRead|CASWrite|RangeSlice), name=Latency><>(Mean|99thPercentile):'
    name: cassandra_clientrequest_latency_$2
    labels:
      scope: "$1"
    type: GAUGE
  - pattern: 'org.apache.cassandra.metrics<type=ClientRequest, scope=(Read|Write|CASRead|CASWrite|RangeSlice), name=(Timeouts|Unavailables|Failures)><>Count:'
    name: cassandra_clientrequest_$2_total
    labels:
      scope: "$1"
    type: COUNTER
  - pattern: 'org.apache.cassandra.metrics<type=Storage, name=(Load|TotalHintsInProgress)><>Count:'
    name: cassandra_storage_$1
    type: GAUGE
  - pattern: 'org.apache.cassandra.metrics<type=Storage, name=(Exceptions|TotalHints)><>Count:'
    name: cassandra_storage_$1_total
    type: COUNTER
  - pattern: 'org.apache.cassandra.metrics<type=Compaction, name=(PendingTasks)><>Value:'
    name: cassandra_compaction_$1
    type: GAUGE
  - pattern: 'org.apache.cassandra.metrics<type=Compaction, name=(CompletedTasks)><>Value:'
    name: cassandra_compaction_$1_total
    type: COUNTER
  - pattern: 'org.apache.cassandra.metrics<type=Compaction, name=(BytesCompacted)><>Count:'
    name: cassandra_compaction_$1_total
    type: COUNTER
  - pattern: 'org.apache.cassandra.metrics<type=ThreadPools, path=(\w+), scope=(\w+), name=(ActiveTasks|PendingTasks)><>Value:'
    name: cassandra_threadpools_$3
    labels:
      path: "$1"
      pool: "$2"
    type: GAUGE
  - pattern: 'org.apache.cassandra.metrics<type=ThreadPools, path=(\w+), scope=(\w+), name=(TotalBlockedTasks)><>Count:'
    name: cassandra_threadpools_$3_total
    labels:
      path: "$1"
      pool: "$2"
    type: COUNTER
  - pattern: 'org.apache.cassandra.metrics<type=DroppedMessage, scope=(\w+), name=Dropped><>Count:'
    name: cassandra_droppedmessage_dropped_total
    labels:
      message_type: "$1"
    type: COUNTER
  - pattern: 'org.apache.cassandra.metrics<type=Client, name=(connectedNativeClients)><>Value:'
    name: cassandra_client_$1
    type: GAUGE
  - pattern: 'org.apache.cassandra.metrics<type=Cache, scope=(KeyCache|RowCache|CounterCache), name=(HitRate|Size|Capacity)><>Value:'
    name: cassandra_cache_$2
    labels:
      cache: "$1"
    type: GAUGE
  - pattern: 'org.apache.cassandra.metrics<type=CommitLog, name=(PendingTasks|TotalCommitLogSize)><>Value:'
    name: cassandra_commitlog_$1
    type: GAUGE

Apache Solr (native metrics)

Solr 9 and 10 publish their metrics in Prometheus format on /solr/admin/metrics?wt=prometheus, without an exporter (Solr 10 has no JMX MBeans left to read). Solr 10 uses OpenTelemetry names, Solr 9 solr_metrics_* names: both sets are kept.

WildFly (native metrics)

WildFly publishes its metrics on /metrics of the management interface (9990, metrics subsystem), without an exporter. Undertow, datasource and transaction statistics with -Dwildfly.statistics-enabled=true (or statistics-enabled per subsystem). The JMX exporter as a javaagent does not start on WildFly 42 (conflict with the JBoss LogManager): the native endpoint is the way to go.

Kubernetes

These products run inside the cluster: declare them in the agent that already reads the cluster (see Kubernetes), with the address of their service, for example:

integrations:
  openmetrics:
    - profile: cert_manager
      url: http://cert-manager.cert-manager.svc:9402
    - profile: velero
      url: http://velero.velero.svc:8085
    - profile: argocd
      url: http://argocd-metrics.argocd.svc:8082
    - profile: argocd_repo_server
      url: http://argocd-repo-server.argocd.svc:8084
    - profile: keda
      url: http://keda-operator.keda.svc:8080

They were tested in a throwaway k3s 1.35 cluster (k3d), read through port forwarding.

cert-manager

Helm chart with prometheus.enabled=true (service on 9402).

The expiry is published as a timestamp: HYPHA shows it as is, and the cert-manager certificate not ready template alerts when issuance or renewal fails.

Velero

Velero server, /metrics on 8085 (metrics.enabled in the chart).

Argo CD

Linkerd

Each meshed pod's proxy publishes its metrics on :4191/metrics. For the whole mesh, rather point at the linkerd-viz Prometheus (/federate?match[]={job="linkerd-proxy"}), which returns the same names with the namespace and deployment labels (not tested: the test read one proxy).

KEDA

KEDA operator, /metrics on 8080 (prometheus.operator.enabled=true in the chart).

Monitor templates

In Monitors › New › From a template:

Ready dashboards

Dashboards › Catalog: one dashboard per product (Consul, Vault, etcd, CoreDNS, Traefik, Envoy, Kong, CockroachDB, n8n, Temporal, Celery, Tomcat, Kafka, ActiveMQ, Cassandra, Solr, WildFly, Pulsar, ScyllaDB, SonarQube, GitLab, cert-manager, Velero, Argo CD, Linkerd, KEDA), installed in one click, then editable like any dashboard.

Updated: 20 November 2026