NeoAnd/evolution-api
1
0
Fork 0
mirror of https://github.com/EvolutionAPI/evolution-api.git synced 2025-12-09 01:49:37 -06:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Elizandro Pacheco 2025-09-16 19:34:44 -03:00
parent 486645fb08
commit 875b874a7b
1 changed files with 60 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

60
src/api/routes/index.router.ts
View File

@ -6,6 +6,7 @@ import { ChatbotRouter } from '@api/integrations/chatbot/chatbot.router';
import { EventRouter } from '@api/integrations/event/event.router';
import { StorageRouter } from '@api/integrations/storage/storage.router';
import { configService } from '@config/env.config';
import { waMonitor } from '@api/server.module';
import { fetchLatestWaWebVersion } from '@utils/fetchLatestWaWebVersion';
import { Router } from 'express';
import fs from 'fs';
@ -42,6 +43,65 @@ const telemetry = new Telemetry();
const packageJson = JSON.parse(fs.readFileSync('./package.json', 'utf8'));
// Expose Prometheus metrics when enabled by env flag
if (process.env.PROMETHEUS_METRICS === 'true') {
router.get('/metrics', async (req, res) => {
res.set('Content-Type', 'text/plain; version=0.0.4; charset=utf-8');
res.set('Cache-Control', 'no-cache, no-store, must-revalidate');
const escapeLabel = (value: unknown) =>
String(value ?? '')
.replace(/\\/g, '\\\\')
.replace(/\n/g, '\\n')
.replace(/"/g, '\\"');
const lines: string[] = [];
const clientName = process.env.DATABASE_CONNECTION_CLIENT_NAME || '';
const serverUrl = serverConfig.URL || '';
// environment info
lines.push('# HELP evolution_environment_info Environment information');
lines.push('# TYPE evolution_environment_info gauge');
lines.push(
`evolution_environment_info{version="${escapeLabel(packageJson.version)}",clientName="${escapeLabel(
clientName,
)}",serverUrl="${escapeLabel(serverUrl)}"} 1`,
);
const instances = (waMonitor && waMonitor.waInstances) || {};
const instanceEntries = Object.entries(instances);
// total instances
lines.push('# HELP evolution_instances_total Total number of instances');
lines.push('# TYPE evolution_instances_total gauge');
lines.push(`evolution_instances_total ${instanceEntries.length}`);
// per-instance status
lines.push('# HELP evolution_instance_up 1 if instance state is open, else 0');
lines.push('# TYPE evolution_instance_up gauge');
lines.push('# HELP evolution_instance_state Instance state as a labelled metric');
lines.push('# TYPE evolution_instance_state gauge');
for (const [name, instance] of instanceEntries) {
const state = instance?.connectionStatus?.state || 'unknown';
const integration = instance?.integration || '';
const up = state === 'open' ? 1 : 0;
lines.push(
`evolution_instance_up{instance="${escapeLabel(name)}",integration="${escapeLabel(integration)}"} ${up}`,
);
lines.push(
`evolution_instance_state{instance="${escapeLabel(name)}",integration="${escapeLabel(
integration,
)}",state="${escapeLabel(state)}"} 1`,
);
}
res.send(lines.join('\n') + '\n');
});
}
if (!serverConfig.DISABLE_MANAGER) router.use('/manager', new ViewsRouter().router);
router.get('/assets/*', (req, res) => {