Skip to content

Commit 0b1ec1a

Browse files
add details of all pre-installed dashboards (#1127)
1 parent 72b277f commit 0b1ec1a

18 files changed

+113
-7
lines changed

docs-source/site/docs/observability/dashboards.md

Lines changed: 113 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,31 @@ More details can be found in the [SigNoz Documentation](https://signoz.io/docs/i
88

99
## Pre-installed dashboards
1010

11-
The following dashboards are pre-installed in SigNoz:
12-
13-
- [Spring Boot Observability](#spring-boot-observability)
14-
- [Spring Boot Statistics](#spring-boot-statistics)
15-
- [Oracle Database Dashboard](#oracle-database-dashboard)
16-
- [Kube State Metrics Dashboard](#kube-state-metrics-dashboard)
17-
- [Apache APISIX Dashboard](#apache-apisix-dashboard)
11+
There are several dashboards that are pre-installed in SigNoz, For example:
12+
13+
- [Pre-installed dashboards](#pre-installed-dashboards)
14+
- [Spring Boot Observability](#spring-boot-observability)
15+
- [Spring Boot Statistics](#spring-boot-statistics)
16+
- [Oracle Database Dashboard](#oracle-database-dashboard)
17+
- [Kube State Metrics Dashboard](#kube-state-metrics-dashboard)
18+
- [Apache APISIX Dashboard](#apache-apisix-dashboard)
19+
- [Helidon Main Dashboard](#helidon-main-dashboard)
20+
- [Helidon MP Details](#helidon-mp-details)
21+
- [Helidon SE Details](#helidon-se-details)
22+
- [Helidon JVM Details](#helidon-jvm-details)
23+
- [APM Metrics](#apm-metrics)
24+
- [Kafka Server Monitoring Dashboard](#kafka-server-monitoring-dashboard)
25+
- [Kubernetes Pod Metrics - Overall](#kubernetes-pod-metrics---overall)
26+
- [Kubernetes Pod Metrics - Detailed](#kubernetes-pod-metrics---detailed)
27+
- [Kubernetes PVC Metrics](#kubernetes-pvc-metrics)
28+
- [Kubernetes Node Metrics - Overall](#kubernetes-node-metrics---overall)
29+
- [Kubernetes Node Metrics - Detailed](#kubernetes-node-metrics---detailed)
30+
- [DB Calls Monitoring](#db-calls-monitoring)
31+
- [Host Metrics (k8s)](#host-metrics-k8s)
32+
- [HTTP API Monitoring](#http-api-monitoring)
33+
- [JVM Metrics](#jvm-metrics)
34+
- [NGINX (OTEL)](#nginx-otel)
35+
- [MicroTx](#microtx)
1836

1937
### Spring Boot Observability
2038

@@ -91,3 +109,91 @@ This dashboard provides details of the APISIX API Gateway including:
91109
Here is an example of this dashboard:
92110

93111
![Apache APISIX Dashboard](images/apache-apisix-dashboard.png)
112+
113+
In addition, following dashboards are also pre-installed:
114+
115+
### Helidon Main Dashboard
116+
Combined dashboard for Heap memory usage statistics about all [Helidon SE](https://helidon.io/docs/v3/about/introduction) and [Helidon MP](https://helidon.io/docs/v4/mp/introduction) applications deployed in cluster.
117+
118+
![Helidon Main Dashboard](images/helidon-main-dashboard.png)
119+
120+
### Helidon MP Details
121+
Details about CPU and Memory usage of [Helidon MP](https://helidon.io/docs/v4/mp/introduction) applications along with statistics about HTTP/REST requests per JVM.
122+
123+
![Helidon MP Dashboard](images/helidon-mp-dashboard.png)
124+
125+
### Helidon SE Details
126+
Details about Memory usage of [Helidon SE](https://helidon.io/docs/v3/about/introduction) applications along with statistics about HTTP/REST requests per JVM.
127+
128+
![Helidon SE Dashboard](images/helidon-se-dashboard.png)
129+
130+
### Helidon JVM Details
131+
JVM level details about Helidon applications, including statistics about [Virtual Threads](https://docs.oracle.com/en/java/javase/24/core/virtual-threads.html), CPU and Memory usage and HTTP requests
132+
133+
![Helidon JVM Dashboard](images/helidon-jvm-dashboard.png)
134+
135+
### APM Metrics
136+
Application Performance overview for all deployed services in terms of request execution times and consistency.
137+
138+
![APM Dashboard](images/apm-dashboard.png)
139+
140+
### Kafka Server Monitoring Dashboard
141+
Details about Kafka brokers, partitions, consumers, topics and partitions etc.
142+
143+
![Kafka Dashboard](images/kafka-dashboard.png)
144+
145+
### Kubernetes Pod Metrics - Overall
146+
Aggregated view of CPU, Memory, FileSystem, and Network usage by pods.
147+
148+
![Kubernetes Pod Metrics Overall](images/k8s-pod-metrics-overall.png)
149+
150+
### Kubernetes Pod Metrics - Detailed
151+
Detailed view of CPU, Memory, FileSystem, and Network usage by pods.
152+
153+
![Kubernetes Pod Metrics Detailed](images/k8s-pod-metrics-detailed.png)
154+
155+
### Kubernetes PVC Metrics
156+
Capacity and Usage statistics about Persistent Volume Claims in the cluster.
157+
158+
![Kubernetes PVC Metrics](images/k8s-pvc-metrics.png)
159+
160+
### Kubernetes Node Metrics - Overall
161+
Aggregated view of CPU, Memory, FileSystem, and Network usage by Nodes in the cluster.
162+
163+
![Kubernetes Node Metrics Overall Dashboard](images/k8s-node-metrics-overall.png)
164+
165+
### Kubernetes Node Metrics - Detailed
166+
Detailed view of CPU, Memory, FileSystem, and Network usage by Nodes in the cluster.
167+
168+
![Kubernetes Node Metrics Detailed Dashboard](images/k8s-node-metrics-detailed.png)
169+
170+
### DB Calls Monitoring
171+
Details about [DB attributes from opentelemetry](https://opentelemetry.io/docs/specs/semconv/attributes-registry/db/).
172+
173+
![Host Metrics Dashboard](images/db-calls-dashboard.png)
174+
175+
### Host Metrics (k8s)
176+
This dashboard uses the system metrics collected from the [hostmetrics receiver](https://uptrace.dev/opentelemetry/collector/host-metrics) to show CPU, Memory, Disk, Network and Filesystem usage
177+
178+
![Host Metrics Dashboard](images/host-metrics-dashboard.png)
179+
180+
### HTTP API Monitoring
181+
This dashboard is built on top of available [HTTP attributes from opentelemetry](https://opentelemetry.io/docs/specs/semconv/attributes-registry/http/) and provides insights about endpoint level performance indicators for HTTP calls.
182+
183+
![HTTP API Dashboard](images/http-api-dashboard.png)
184+
185+
### JVM Metrics
186+
JVM Runtime metrics for all services deployed in cluster in terms of CPU/Memory usage, Garbage collection events, threads and class loading/unloading.
187+
188+
![JVM Metrics Dashboard](images/jvm-metrics-dashboard.png)
189+
190+
### NGINX (OTEL)
191+
Details about connections/requests being handled by the the [NGINX Ingress controller](https://github.com/kubernetes/ingress-nginx).
192+
193+
![Nginx Dashboard](images/nginx-dashboard.png)
194+
195+
### MicroTx
196+
Details about Transaction Manager for Microservices(https://docs.oracle.com/en/database/oracle/transaction-manager-for-microservices/24.2/tmmdg/oracle-transaction-manager-microservices.html) component and statistics about participating transactions.
197+
198+
![MicroTx Dashboard](images/microtx-dashboard.png)
199+
209 KB
Loading
232 KB
Loading
155 KB
Loading
144 KB
Loading
146 KB
Loading
147 KB
Loading
299 KB
Loading
211 KB
Loading
259 KB
Loading

0 commit comments

Comments
 (0)