Core conceptsTesting and monitoring
The Network dashboards in the Unleash Admin UI are designed to give you an overview of incoming requests to your Unleash instance. This includes requests from Unleash SDKs, Unleash Edge, or the Unleash Admin UI.
To use these dashboards, you must configure an external data source.
Requests from Unleash SDKs and other official Unleash applications include an application name. Requests that don’t include an application name header (UNLEASH_APPNAME) are marked and aggregated as unknown.
You can access the Network dashboards in Admin settings > Network in the Unleash Admin UI.
The Overview section displays the Unleash instance and applications that have connected to it within the last five minutes. Unknown applications are excluded from this view.
Each application in the diagram includes its name and the average number of requests per second over the last five minutes.
The Traffic section presents the requests that have consumed the most network traffic in the last six hours. These requests are grouped by client and base URL, with up to ten groups displayed.
Unleash aggregates requests by application name and base URL. Base URLs are batched using the first two path segments after /api. This means that Admin API requests are separate from Client API requests.
The Data Usage dashboard provides an overview of your requests to Unleash within a specific month, along with aggregated data over the last 3, 6, or 12 months. This allows you to track and assess your data usage over time. You can also compare your usage in previous months with the current month.
To populate the Network dashboards, Unleash needs to read metrics from a Prometheus-compatible HTTP API (for example, Prometheus or VictoriaMetrics).
For this, you need to set up a two-way flow between Unleash and a Prometheus-compatible monitoring system:
PROMETHEUS_API) to render the dashboards.First, you must configure your Prometheus instance to pull metrics from Unleash’s backstage API endpoint.
Add the following scrape job to your Prometheus configuration file (for example, prometheus.yml). Replace ‘your-unleash-url’ with the base URL of your Unleash instance.
This job tells Prometheus to periodically fetch metrics from the /internal-backstage/prometheus path on your Unleash server.
Set the PROMETHEUS_API environment variable in your Unleash instance to the base URL of your Prometheus-compatible query API. This URL must be network-accessible from your Unleash instance. It can be an internal service name (such as http://prometheus.monitoring.svc.cluster.local) or a public URL.