Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
120 changes: 113 additions & 7 deletions docs-source/site/docs/observability/dashboards.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,31 @@ More details can be found in the [SigNoz Documentation](https://signoz.io/docs/i

## Pre-installed dashboards

The following dashboards are pre-installed in SigNoz:

- [Spring Boot Observability](#spring-boot-observability)
- [Spring Boot Statistics](#spring-boot-statistics)
- [Oracle Database Dashboard](#oracle-database-dashboard)
- [Kube State Metrics Dashboard](#kube-state-metrics-dashboard)
- [Apache APISIX Dashboard](#apache-apisix-dashboard)
There are several dashboards that are pre-installed in SigNoz, For example:

- [Pre-installed dashboards](#pre-installed-dashboards)
- [Spring Boot Observability](#spring-boot-observability)
- [Spring Boot Statistics](#spring-boot-statistics)
- [Oracle Database Dashboard](#oracle-database-dashboard)
- [Kube State Metrics Dashboard](#kube-state-metrics-dashboard)
- [Apache APISIX Dashboard](#apache-apisix-dashboard)
- [Helidon Main Dashboard](#helidon-main-dashboard)
- [Helidon MP Details](#helidon-mp-details)
- [Helidon SE Details](#helidon-se-details)
- [Helidon JVM Details](#helidon-jvm-details)
- [APM Metrics](#apm-metrics)
- [Kafka Server Monitoring Dashboard](#kafka-server-monitoring-dashboard)
- [Kubernetes Pod Metrics - Overall](#kubernetes-pod-metrics---overall)
- [Kubernetes Pod Metrics - Detailed](#kubernetes-pod-metrics---detailed)
- [Kubernetes PVC Metrics](#kubernetes-pvc-metrics)
- [Kubernetes Node Metrics - Overall](#kubernetes-node-metrics---overall)
- [Kubernetes Node Metrics - Detailed](#kubernetes-node-metrics---detailed)
- [DB Calls Monitoring](#db-calls-monitoring)
- [Host Metrics (k8s)](#host-metrics-k8s)
- [HTTP API Monitoring](#http-api-monitoring)
- [JVM Metrics](#jvm-metrics)
- [NGINX (OTEL)](#nginx-otel)
- [MicroTx](#microtx)

### Spring Boot Observability

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

![Apache APISIX Dashboard](images/apache-apisix-dashboard.png)

In addition, following dashboards are also pre-installed:

### Helidon Main Dashboard
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.

![Helidon Main Dashboard](images/helidon-main-dashboard.png)

### Helidon MP Details
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.

![Helidon MP Dashboard](images/helidon-mp-dashboard.png)

### Helidon SE Details
Details about Memory usage of [Helidon SE](https://helidon.io/docs/v3/about/introduction) applications along with statistics about HTTP/REST requests per JVM.

![Helidon SE Dashboard](images/helidon-se-dashboard.png)

### Helidon JVM Details
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

![Helidon JVM Dashboard](images/helidon-jvm-dashboard.png)

### APM Metrics
Application Performance overview for all deployed services in terms of request execution times and consistency.

![APM Dashboard](images/apm-dashboard.png)

### Kafka Server Monitoring Dashboard
Details about Kafka brokers, partitions, consumers, topics and partitions etc.

![Kafka Dashboard](images/kafka-dashboard.png)

### Kubernetes Pod Metrics - Overall
Aggregated view of CPU, Memory, FileSystem, and Network usage by pods.

![Kubernetes Pod Metrics Overall](images/k8s-pod-metrics-overall.png)

### Kubernetes Pod Metrics - Detailed
Detailed view of CPU, Memory, FileSystem, and Network usage by pods.

![Kubernetes Pod Metrics Detailed](images/k8s-pod-metrics-detailed.png)

### Kubernetes PVC Metrics
Capacity and Usage statistics about Persistent Volume Claims in the cluster.

![Kubernetes PVC Metrics](images/k8s-pvc-metrics.png)

### Kubernetes Node Metrics - Overall
Aggregated view of CPU, Memory, FileSystem, and Network usage by Nodes in the cluster.

![Kubernetes Node Metrics Overall Dashboard](images/k8s-node-metrics-overall.png)

### Kubernetes Node Metrics - Detailed
Detailed view of CPU, Memory, FileSystem, and Network usage by Nodes in the cluster.

![Kubernetes Node Metrics Detailed Dashboard](images/k8s-node-metrics-detailed.png)

### DB Calls Monitoring
Details about [DB attributes from opentelemetry](https://opentelemetry.io/docs/specs/semconv/attributes-registry/db/).

![Host Metrics Dashboard](images/db-calls-dashboard.png)

### Host Metrics (k8s)
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

![Host Metrics Dashboard](images/host-metrics-dashboard.png)

### HTTP API Monitoring
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.

![HTTP API Dashboard](images/http-api-dashboard.png)

### JVM Metrics
JVM Runtime metrics for all services deployed in cluster in terms of CPU/Memory usage, Garbage collection events, threads and class loading/unloading.

![JVM Metrics Dashboard](images/jvm-metrics-dashboard.png)

### NGINX (OTEL)
Details about connections/requests being handled by the the [NGINX Ingress controller](https://github.com/kubernetes/ingress-nginx).

![Nginx Dashboard](images/nginx-dashboard.png)

### MicroTx
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.

![MicroTx Dashboard](images/microtx-dashboard.png)

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.