Skip to content

Commit db8ca4d

Browse files
weltekialexellis
authored andcommitted
Add graphs section to dashboard docs
Include in overview of the available graphs with a screenshot and short explanation for each. Signed-off-by: Han Verstraete (OpenFaaS Ltd) <[email protected]>
1 parent 42fa3d8 commit db8ca4d

File tree

4 files changed

+38
-0
lines changed

4 files changed

+38
-0
lines changed
333 KB
Loading

docs/images/dashboard/load-graphs.png

100 KB
Loading
136 KB
Loading

docs/openfaas-pro/dashboard.md

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -279,6 +279,44 @@ spec:
279279

280280
You can use the same tunnel and exit server for multiple domains, to expose both the gateway and the dashboard with TLS and authentication.
281281

282+
## Graphs
283+
284+
!!! note
285+
286+
Available in [ghcr.io/openfaasltd/openfaas-dashboard:0.5.26](https://github.com/openfaasltd/openfaas-dashboard/pkgs/container/openfaas-dashboard) or later.
287+
288+
The OpenFaaS dashboard comes with built-in graphs to give you better visibility into function behavior and resource utilization, making it easier to debug and optimize your workloads.
289+
290+
It provides detailed metrics for individual functions, including:
291+
292+
**Invocation metrics**
293+
294+
Rate, Error, Duration (RED) metrics.
295+
296+
- `Invocation rate by status code` - Function invocation rate over the last 30s broken down by status code.
297+
- `Latency by status code` - Average function invocation latency over the last 30s broken down by status code.
298+
299+
![Invocation graphs](/images/dashboard/invocation-graphs.png)
300+
301+
**Load metrics**
302+
303+
View function replica count and current load.
304+
305+
- `Load` - Load as measured by the autoscaler.
306+
- `Replicas` - Function replica count.
307+
308+
![Load graphs](/images/dashboard/load-graphs.png)
309+
310+
**Resource usage**
311+
312+
CPU/RAM usage of functions.
313+
314+
- `CPU usage` - CPU usage of the function across all replicas, measured in milli-CPU.
315+
- `Memory usage` - Memory usage of the function across all replicas.
316+
317+
![Resource usage graphs](/images/dashboard/resource-graphs.png)
318+
319+
282320
## Would you like a demo?
283321

284322
Feel free to reach out to us for a demo or to ask any questions you may have.

0 commit comments

Comments
 (0)