From 1cd44d29157d77f665d0c3b1812933ec99824593 Mon Sep 17 00:00:00 2001 From: Ilango Rajagopal Date: Wed, 17 Dec 2025 15:09:01 +0530 Subject: [PATCH 1/4] fix: prometheus docs --- en/using-flowise/monitoring.md | 29 +++++++++++++++++++++++++---- esp/usar-flowise/monitoring.md | 30 +++++++++++++++++++++++++----- 2 files changed, 50 insertions(+), 9 deletions(-) diff --git a/en/using-flowise/monitoring.md b/en/using-flowise/monitoring.md index 2369c71c..1412993f 100644 --- a/en/using-flowise/monitoring.md +++ b/en/using-flowise/monitoring.md @@ -14,15 +14,36 @@ METRICS_PROVIDER=prometheus METRICS_INCLUDE_NODE_METRICS=true ``` +## Authentication Setup + +The `/api/v1/metrics` endpoint requires API key authentication. You'll need to: + +1. Generate an API key following the instructions [here](https://docs.flowiseai.com/configuration/authorization/chatflow-level#api-key) +2. Save the API key to a file accessible by Prometheus (e.g., `/etc/prometheus/api_key.txt`) +3. Configure Prometheus to use bearer token authentication + +## Prometheus Configuration + After Prometheus is installed, run it using a configuration file. Flowise provides a default configuration file that can be found [here](https://github.com/FlowiseAI/Flowise/blob/main/metrics/prometheus/prometheus.config.yml). -Remember to have Flowise instance also running. You can open browser and navigate to port 9090. From the dashboard, you should be able to see the metric endpoint - `/api/v1/metrics` is now live. +You'll need to add authentication configuration to your Prometheus config file: + +```yaml +scrape_configs: + - job_name: 'flowise' + static_configs: + - targets: ['localhost:3000'] + metrics_path: '/api/v1/metrics' + authorization: + type: Bearer + credentials_file: '/etc/prometheus/api_key.txt' +``` -
+Remember to have Flowise instance also running. You can open browser and navigate to port 9090. From the dashboard, you should be able to see the metric endpoint - `/api/v1/metrics` is now live with authentication. -By default, `/api/v1/metrics` is available for Prometheus to pull the metrics from. +
-
+The `/api/v1/metrics` endpoint is available for Prometheus to pull metrics from, but requires API key authentication as configured above. ## Grafana diff --git a/esp/usar-flowise/monitoring.md b/esp/usar-flowise/monitoring.md index d89d23cc..60654679 100644 --- a/esp/usar-flowise/monitoring.md +++ b/esp/usar-flowise/monitoring.md @@ -14,15 +14,36 @@ METRICS_PROVIDER=prometheus METRICS_INCLUDE_NODE_METRICS=true ``` +## Configuración de Autenticación + +El punto final `/api/v1/metrics` requiere autenticación con clave API. Necesitarás: + +1. Generar una clave API siguiendo las instrucciones [aquí](https://docs.flowiseai.com/configuration/authorization/chatflow-level#api-key) +2. Guardar la clave API en un archivo accesible por Prometheus (ej., `/etc/prometheus/api_key.txt`) +3. Configurar Prometheus para usar autenticación con token bearer + +## Configuración de Prometheus + Después de instalar Prometheus, ejecútalo usando un archivo de configuración. Flowise proporciona un archivo de configuración predeterminado que se puede encontrar [aquí](https://github.com/FlowiseAI/Flowise/blob/main/metrics/prometheus/prometheus.config.yml). -Recuerda tener la instancia de Flowise también en ejecución. Puedes abrir el navegador y navegar al puerto 9090. Desde el panel de control, deberías poder ver que el punto final de métricas - `/api/v1/metrics` está activo. +Necesitarás agregar configuración de autenticación a tu archivo de configuración de Prometheus: + +```yaml +scrape_configs: + - job_name: 'flowise' + static_configs: + - targets: ['localhost:3000'] + metrics_path: '/api/v1/metrics' + authorization: + type: Bearer + credentials_file: '/etc/prometheus/api_key.txt' +``` -
+Recuerda tener la instancia de Flowise también en ejecución. Puedes abrir el navegador y navegar al puerto 9090. Desde el panel de control, deberías poder ver que el punto final de métricas - `/api/v1/metrics` está activo con autenticación. -Por defecto, `/api/v1/metrics` está disponible para que Prometheus extraiga las métricas. +
-
+El punto final `/api/v1/metrics` está disponible para que Prometheus extraiga las métricas, pero requiere autenticación con clave API como se configuró anteriormente. ## Grafana @@ -95,4 +116,3 @@ docker compose up -d El recolector utilizará el archivo [otel.config.yml](https://github.com/FlowiseAI/Flowise/blob/main/metrics/otel/otel.config.yml) bajo el mismo directorio para las configuraciones. Actualmente solo [Datadog](https://www.datadoghq.com/) y Prometheus son soportados, consulta la documentación de [Open Telemetry](https://opentelemetry.io/) para configurar diferentes herramientas APM como Zipkin, Jeager, New Relic, Splunk y otros. Asegúrate de reemplazar con la clave API necesaria para los exportadores dentro del archivo yml. - From 94f409b9e8a3009d3c229d2fb3a3a0bb5a8ea401 Mon Sep 17 00:00:00 2001 From: Ilango Rajagopal Date: Wed, 17 Dec 2025 15:11:32 +0530 Subject: [PATCH 2/4] fix: headings --- en/using-flowise/monitoring.md | 4 ++-- esp/usar-flowise/monitoring.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/en/using-flowise/monitoring.md b/en/using-flowise/monitoring.md index 1412993f..21b811cb 100644 --- a/en/using-flowise/monitoring.md +++ b/en/using-flowise/monitoring.md @@ -14,7 +14,7 @@ METRICS_PROVIDER=prometheus METRICS_INCLUDE_NODE_METRICS=true ``` -## Authentication Setup +### Authentication Setup The `/api/v1/metrics` endpoint requires API key authentication. You'll need to: @@ -22,7 +22,7 @@ The `/api/v1/metrics` endpoint requires API key authentication. You'll need to: 2. Save the API key to a file accessible by Prometheus (e.g., `/etc/prometheus/api_key.txt`) 3. Configure Prometheus to use bearer token authentication -## Prometheus Configuration +### Prometheus Configuration After Prometheus is installed, run it using a configuration file. Flowise provides a default configuration file that can be found [here](https://github.com/FlowiseAI/Flowise/blob/main/metrics/prometheus/prometheus.config.yml). diff --git a/esp/usar-flowise/monitoring.md b/esp/usar-flowise/monitoring.md index 60654679..12bba4fa 100644 --- a/esp/usar-flowise/monitoring.md +++ b/esp/usar-flowise/monitoring.md @@ -14,7 +14,7 @@ METRICS_PROVIDER=prometheus METRICS_INCLUDE_NODE_METRICS=true ``` -## Configuración de Autenticación +### Configuración de Autenticación El punto final `/api/v1/metrics` requiere autenticación con clave API. Necesitarás: @@ -22,7 +22,7 @@ El punto final `/api/v1/metrics` requiere autenticación con clave API. Necesita 2. Guardar la clave API en un archivo accesible por Prometheus (ej., `/etc/prometheus/api_key.txt`) 3. Configurar Prometheus para usar autenticación con token bearer -## Configuración de Prometheus +### Configuración de Prometheus Después de instalar Prometheus, ejecútalo usando un archivo de configuración. Flowise proporciona un archivo de configuración predeterminado que se puede encontrar [aquí](https://github.com/FlowiseAI/Flowise/blob/main/metrics/prometheus/prometheus.config.yml). From 76544e8eaa0dc71b081c0096506d01740ae58b35 Mon Sep 17 00:00:00 2001 From: Ilango Rajagopal Date: Wed, 17 Dec 2025 15:16:12 +0530 Subject: [PATCH 3/4] fix: links --- en/using-flowise/monitoring.md | 2 +- esp/usar-flowise/monitoring.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/en/using-flowise/monitoring.md b/en/using-flowise/monitoring.md index 21b811cb..7335abb1 100644 --- a/en/using-flowise/monitoring.md +++ b/en/using-flowise/monitoring.md @@ -18,7 +18,7 @@ METRICS_INCLUDE_NODE_METRICS=true The `/api/v1/metrics` endpoint requires API key authentication. You'll need to: -1. Generate an API key following the instructions [here](https://docs.flowiseai.com/configuration/authorization/chatflow-level#api-key) +1. Generate an API key following the instructions [here](../configuration/authorization/chatflow-level#api-key) 2. Save the API key to a file accessible by Prometheus (e.g., `/etc/prometheus/api_key.txt`) 3. Configure Prometheus to use bearer token authentication diff --git a/esp/usar-flowise/monitoring.md b/esp/usar-flowise/monitoring.md index 12bba4fa..9a152d42 100644 --- a/esp/usar-flowise/monitoring.md +++ b/esp/usar-flowise/monitoring.md @@ -18,7 +18,7 @@ METRICS_INCLUDE_NODE_METRICS=true El punto final `/api/v1/metrics` requiere autenticación con clave API. Necesitarás: -1. Generar una clave API siguiendo las instrucciones [aquí](https://docs.flowiseai.com/configuration/authorization/chatflow-level#api-key) +1. Generar una clave API siguiendo las instrucciones [aquí](../configuracion/autorizacion/nivel-chatflow#api-key) 2. Guardar la clave API en un archivo accesible por Prometheus (ej., `/etc/prometheus/api_key.txt`) 3. Configurar Prometheus para usar autenticación con token bearer From 54b788439dafed9fa9bab4f9b24c6941b7496fc1 Mon Sep 17 00:00:00 2001 From: Ilango Rajagopal Date: Wed, 17 Dec 2025 15:17:59 +0530 Subject: [PATCH 4/4] fix: links --- en/using-flowise/monitoring.md | 2 +- esp/usar-flowise/monitoring.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/en/using-flowise/monitoring.md b/en/using-flowise/monitoring.md index 7335abb1..21b811cb 100644 --- a/en/using-flowise/monitoring.md +++ b/en/using-flowise/monitoring.md @@ -18,7 +18,7 @@ METRICS_INCLUDE_NODE_METRICS=true The `/api/v1/metrics` endpoint requires API key authentication. You'll need to: -1. Generate an API key following the instructions [here](../configuration/authorization/chatflow-level#api-key) +1. Generate an API key following the instructions [here](https://docs.flowiseai.com/configuration/authorization/chatflow-level#api-key) 2. Save the API key to a file accessible by Prometheus (e.g., `/etc/prometheus/api_key.txt`) 3. Configure Prometheus to use bearer token authentication diff --git a/esp/usar-flowise/monitoring.md b/esp/usar-flowise/monitoring.md index 9a152d42..6d70d121 100644 --- a/esp/usar-flowise/monitoring.md +++ b/esp/usar-flowise/monitoring.md @@ -18,7 +18,7 @@ METRICS_INCLUDE_NODE_METRICS=true El punto final `/api/v1/metrics` requiere autenticación con clave API. Necesitarás: -1. Generar una clave API siguiendo las instrucciones [aquí](../configuracion/autorizacion/nivel-chatflow#api-key) +1. Generar una clave API siguiendo las instrucciones [aquí](https://docs.flowiseai.com/espanol/documentacion-oficial/configuracion/autorizacion/nivel-chatflow#api-key) 2. Guardar la clave API en un archivo accesible por Prometheus (ej., `/etc/prometheus/api_key.txt`) 3. Configurar Prometheus para usar autenticación con token bearer