Skip to content

fix: prometheus docs #196

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
0xi4o wants to merge 4 commits into
base: main
Choose a base branch
from
Open

fix: prometheus docs #196

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1cd44d2
fix: prometheus docs
0xi4o Dec 17, 2025
94f409b
fix: headings
0xi4o Dec 17, 2025
76544e8
fix: links
0xi4o Dec 17, 2025
54b7884
fix: links
0xi4o Dec 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 25 additions & 4 deletions en/using-flowise/monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
```

<figure><img src="../.gitbook/assets/image (178).png" alt=""><figcaption></figcaption></figure>
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.
<figure><img src="../.gitbook/assets/image (178).png" alt=""><figcaption></figcaption></figure>

<figure><img src="../.gitbook/assets/image (177).png" alt="" width="563"><figcaption></figcaption></figure>
The `/api/v1/metrics` endpoint is available for Prometheus to pull metrics from, but requires API key authentication as configured above.

## Grafana

Expand Down
30 changes: 25 additions & 5 deletions esp/usar-flowise/monitoring.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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'
```

<figure><img src="../.gitbook/assets/image (178).png" alt=""><figcaption></figcaption></figure>
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.
<figure><img src="../.gitbook/assets/image (178).png" alt=""><figcaption></figcaption></figure>

<figure><img src="../.gitbook/assets/image (177).png" alt="" width="563"><figcaption></figcaption></figure>
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

Expand Down Expand Up @@ -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.