iframe-proxy

elizandropacheco · 2025-09-16T22:37:20Z

Title

feat: add Prometheus-compatible /metrics endpoint (gated by PROMETHEUS_METRICS)

Description

This PR introduces a Prometheus-compatible metrics endpoint to expose runtime and instance-level insights for Evolution API. The endpoint is disabled by default and can be enabled via an environment flag.

What’s changed

Added a new GET /metrics route in src/api/routes/index.router.ts, conditionally registered when process.env.PROMETHEUS_METRICS === 'true'.
The endpoint outputs Prometheus 0.0.4 text format (text/plain) with a minimal, stable metric set:
- evolution_environment_info{version,clientName,serverUrl} 1 — environment metadata
- evolution_instances_total — number of instances currently tracked
- evolution_instance_up{instance,integration} — 1 if state == "open", else 0
- evolution_instance_state{instance,integration,state} — labeled gauge with the current state
The route uses waMonitor.waInstances (no auth required) so Prometheus can scrape it by default.

Why

Provide first-party observability without sidecars.
Enable dashboards/alerts around instance states (e.g., detect disconnections).
Expose environment metadata for troubleshooting and inventory.

How to use

Set:

PROMETHEUS_METRICS=true

Start the server and scrape:

GET /metrics
Content-Type: text/plain; version=0.0.4; charset=utf-8

Create/connect instances to see:

evolution_instances_total increase
evolution_instance_up flip to 1 when an instance state is open

Example output

# HELP evolution_environment_info Environment information
# TYPE evolution_environment_info gauge
evolution_environment_info{version="2.3.2",clientName="evolution_exchange",serverUrl="http://localhost:8080"} 1
# HELP evolution_instances_total Total number of instances
# TYPE evolution_instances_total gauge
evolution_instances_total 3
# HELP evolution_instance_up 1 if instance state is open, else 0
# TYPE evolution_instance_up gauge
# HELP evolution_instance_state Instance state as a labelled metric
# TYPE evolution_instance_state gauge
evolution_instance_up{instance="demo-1",integration="WHATSAPP-BAILEYS"} 0
evolution_instance_state{instance="demo-1",integration="WHATSAPP-BAILEYS",state="close"} 1

Notes

Auth is intentionally not required for Prometheus scraping. A follow-up PR can add optional guards or an allowlist.
Metric set is intentionally small and stable to avoid cardinality spikes; can be extended later.

Files changed

src/api/routes/index.router.ts

Checklist

Conditional registration via PROMETHEUS_METRICS
Prometheus 0.0.4 text output
Instance state reflected per instance/integration labels
README/CHANGELOG mention (if maintainers prefer)
Optional tests (enabled/disabled paths)

Summary by Sourcery

Add an optional Prometheus metrics endpoint for environment and instance-level insights, and adjust the deployment setup with a dedicated Dockerfile and updated docker-compose configuration.

New Features:

Expose a Prometheus-compatible /metrics endpoint gated by the PROMETHEUS_METRICS environment flag
Emit environment metadata, total instances, and per-instance up/state gauges in Prometheus text format

Build:

Introduce Dockerfile.metrics and update docker-compose to use the evolution/api:metrics image

…S_METRICS)

sourcery-ai · 2025-09-16T22:37:26Z

Reviewer's Guide

This PR adds a conditional Prometheus-compatible /metrics endpoint that streams environment and instance-level gauges in text format and updates the Docker setup to build and deploy a metrics‐enabled image.

Sequence diagram for conditional /metrics endpoint registration and response

sequenceDiagram
participant Env as "process.env"
participant Router as "Express Router"
participant Prometheus as "Prometheus Scraper"
participant Server as "API Server"
participant waMonitor as "waMonitor"

Env->>Router: PROMETHEUS_METRICS === 'true'
Router->>Server: Register GET /metrics route
Prometheus->>Server: GET /metrics
Server->>waMonitor: Read waInstances
Server->>Prometheus: Return metrics text (environment info, instances, states)

File-Level Changes

Change	Details	Files
Introduce conditional Prometheus /metrics route	Wrap route registration in PROMETHEUS_METRICS check Set Content-Type and Cache-Control headers for Prometheus format Implement escapeLabel utility to sanitize metric labels Assemble and send text/plain 0.0.4 metrics for environment info, total instances, and per-instance state	`src/api/routes/index.router.ts`
Update Docker configuration for metrics image	Change service image to metrics-enabled tag Add Dockerfile.metrics to build the metrics image	`docker-compose.yaml` `Dockerfile.metrics`

Tips and commands

Interacting with Sourcery

Trigger a new review: Comment @sourcery-ai review on the pull request.
Continue discussions: Reply directly to Sourcery's review comments.
Generate a GitHub issue from a review comment: Ask Sourcery to create an
issue from a review comment by replying to it. You can also reply to a
review comment with @sourcery-ai issue to create an issue from it.
Generate a pull request title: Write @sourcery-ai anywhere in the pull
request title to generate a title at any time. You can also comment
@sourcery-ai title on the pull request to (re-)generate the title at any time.
Generate a pull request summary: Write @sourcery-ai summary anywhere in
the pull request body to generate a PR summary at any time exactly where you
want it. You can also comment @sourcery-ai summary on the pull request to
(re-)generate the summary at any time.
Generate reviewer's guide: Comment @sourcery-ai guide on the pull
request to (re-)generate the reviewer's guide at any time.
Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
pull request to resolve all Sourcery comments. Useful if you've already
addressed all the comments and don't want to see them anymore.
Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
request to dismiss all existing Sourcery reviews. Especially useful if you
want to start fresh with a new review - don't forget to comment
@sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

Enable or disable review features such as the Sourcery-generated pull request
summary, the reviewer's guide, and others.
Change the review language.
Add, remove or edit custom review instructions.
Adjust other review settings.

Getting Help

Contact our support team for questions or feedback.
Visit our documentation for detailed guides and information.
Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

sourcery-ai

Hey there - I've reviewed your changes - here's some feedback:

Consider using a Prometheus client library (e.g., prom-client) instead of manually assembling metric strings for better maintainability and safety.
Move the metrics formatting and escapeLabel logic into a separate module or service so the router remains focused on request handling.
Pull static metrics definitions (HELP/TYPE lines and escapeLabel helper) out of the handler to avoid recreating them on every scrape.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- Consider using a Prometheus client library (e.g., prom-client) instead of manually assembling metric strings for better maintainability and safety.
- Move the metrics formatting and escapeLabel logic into a separate module or service so the router remains focused on request handling.
- Pull static metrics definitions (HELP/TYPE lines and escapeLabel helper) out of the handler to avoid recreating them on every scrape.

## Individual Comments

### Comment 1
<location> `src/api/routes/index.router.ts:60` </location>
<code_context>
+
+    const lines: string[] = [];
+
+    const clientName = process.env.DATABASE_CONNECTION_CLIENT_NAME || '';
+    const serverUrl = serverConfig.URL || '';
+
</code_context>

<issue_to_address>
**suggestion:** Defaulting to empty string for clientName may obscure missing configuration.

Using an empty string may hide configuration problems in metrics. A sentinel value like 'unknown' would make missing configuration clearer in Prometheus.

```suggestion
    const clientName = process.env.DATABASE_CONNECTION_CLIENT_NAME || 'unknown';
```
</issue_to_address>

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

DavidsonGomes · 2025-09-17T11:54:16Z

Please, fix the lint with npm run lint

elizandropacheco · 2025-09-17T15:07:53Z

elizandropacheco added 2 commits September 16, 2025 19:35

feat: add Prometheus-compatible /metrics endpoint (gated by PROMETHEU…

875b874

…S_METRICS)

chore: local compose/image tweaks for testing metrics (not part of PR)

a3223ec

sourcery-ai Bot reviewed Sep 16, 2025

View reviewed changes

Comment thread src/api/routes/index.router.ts Outdated

chore(metrics): use 'unknown' as fallback for clientName label

0e737d4

style(metrics): linted index.router.ts after eslint --fix

edfcb0c

DavidsonGomes merged commit e75dae3 into EvolutionAPI:develop Sep 17, 2025
2 checks passed

Sunbelt Computer Software

PL/B Language Development and Support

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/prometheus metrics#1947

Feat/prometheus metrics#1947
DavidsonGomes merged 4 commits intoEvolutionAPI:developfrom
elizandropacheco:feat/prometheus-metrics

elizandropacheco commented Sep 16, 2025 •

edited by sourcery-ai Bot

Loading

Uh oh!

sourcery-ai Bot commented Sep 16, 2025 •

edited

Loading

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai Bot left a comment

Uh oh!

Uh oh!

DavidsonGomes commented Sep 17, 2025

Uh oh!

elizandropacheco commented Sep 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Sunbelt Computer Software

PL/B Language Development and Support

Conversation

elizandropacheco commented Sep 16, 2025 • edited by sourcery-ai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Title

Description

What’s changed

Why

How to use

Example output

Notes

Files changed

Checklist

Summary by Sourcery

Uh oh!

sourcery-ai Bot commented Sep 16, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Reviewer's Guide

Sequence diagram for conditional /metrics endpoint registration and response

File-Level Changes

Interacting with Sourcery

Customizing Your Experience

Getting Help

Uh oh!

sourcery-ai Bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

DavidsonGomes commented Sep 17, 2025

Uh oh!

elizandropacheco commented Sep 17, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

elizandropacheco commented Sep 16, 2025 •

edited by sourcery-ai Bot

Loading

sourcery-ai Bot commented Sep 16, 2025 •

edited

Loading