- docs
- FlowFuse User Manuals
- Using FlowFuse
- Getting Started
- FlowFuse Concepts
- Changing the Stack
- Device Groups
- DevOps Pipelines
- Environment Variables
- FlowFuse File Nodes
- FlowFuse Persistent Context
- FlowFuse Project Nodes
- High Availability mode
- Instance Settings
- Logging
- Shared Team Library
- Snapshots
- Teams
- User Settings
- FlowFuse API
- Migrating a Node-RED project to FlowFuse
- Device Agent
- Device Agent
- FlowFuse Device Agent Introduction
- Quick Start
- Installation
- Quick Start with Web UI
- Register your Device
- Running the Agent
- Deploying your Flows
- Hardware Guides
- FlowFuse Cloud
- FlowFuse Cloud
- FlowFuse Self-Hosted
- Installing FlowFuse
- Overview
- Configuring FlowFuse
- DNS Setup
- Docker install
- Email configuration
- First Run Setup
- FlowFuse File Storage
- Install FlowFuse on Kubernetes
- Local Install
- Upgrading FlowFuse
- Administering FlowFuse
- Administering FlowFuse
- Administrator configuration for SSO
- licensing
- Monitoring
- Telemetry
- User Management
- Support
- Community Support
- Premium Support
- Debugging Node-RED issues
- Contributing
- Contributing to FlowFuse
# Platform Monitoring
FlowFuse provides an API end-point that can be used to monitor statistical information about the platform.
The end-point is accessible to any logged-in Admin user at the url (replace example.com
with the domain of your FlowFuse instance)
https://example.com/api/v1/admin/stats
By default, it returns a JSON object containing key statistics such as the number of users, instances, and other information.
If the accept header of the http request includes application/openmetrics-text
then the response is formatted as OpenMetrics text. This can be directly consumed by tools such as Prometheus.
# Enabling token-based access
In Admin Settings there is an option to allow token-based access to platform statistics.
When enabled, the platform will generate an access token that can be used to access the end-point without having a full Admin login. This is useful when configuring tools such as Prometheus to monitor the platform.
- Under Admin Settings -> General, check the 'allow token-based access' option
- A dialog is shown containing the token. This is the only time the token will be shown - make sure you record its value.
The token should be provided as a bearer token in any http request to the end-point;
TOKEN=your_generated_token
curl -H 'Authorization: Bearer $TOKEN' https://example.com/api/v1/admin/stats