Skip to main content
Version: Next

Pre-installed dashboards

note

More details can be found in the SigNoz Documentation.

SigNoz dashboard migration

SigNoz v0.135.0 deprecates the Dashboards V1 schema and retires the V1 dashboard API endpoints. User-supplied dashboards that use the V1 format must be migrated to the Dashboards V2/Perses-compatible schema before upgrading. Dashboards managed only through the SigNoz UI are migrated automatically, but verify that none remain marked Legacy. See the SigNoz v0.135.0 upgrade guide for migration details.

To install your own dashboards with Helm, see Custom dashboards.

Dashboard setup Job​

The OBaaS chart runs <app-release>-signoz-setup after installation and upgrade when signoz.setup.enabled is true (the default). The Job runs Python 3 on container-registry.oracle.com/os/oraclelinux:9, using a script mounted from a ConfigMap. It waits for SigNoz to become healthy, then signs in with the email and password from the Secret selected by signoz.auth.existingSecret, or signoz-authn when no existing Secret is configured.

The Job discovers the organization through /api/v2/sessions/context. If the account belongs to multiple organizations, add an orgID key containing the selected organization's UUID to the credential Secret. A non-empty orgID takes precedence over discovery. This setup uses the SigNoz API and does not mount the SigNoz metadata database PVC, so it also works with PostgreSQL metadata storage.

On each run, the Job deletes existing dashboards whose names exactly match the bundled system dashboards, including matching legacy records, then recreates them through the V2 API. Their IDs change and edits to these system dashboards are replaced. Dashboards with other names are left alone. Save customized copies under distinct names. Bundled V1 payloads are skipped; imported system dashboards use the V2/Perses schemaVersion: v6 format.

Check completion and logs with:

kubectl -n <application-namespace> wait --for=condition=complete \
job/<app-release>-signoz-setup --timeout=5m
kubectl -n <application-namespace> logs job/<app-release>-signoz-setup \
-c signoz-setup

Successful logs end with SigNoz setup complete. For private registries, override signoz.setup.image.registry, signoz.setup.image.repository, and signoz.setup.image.tag; see the private registry configuration.

Included dashboards​

There are several dashboards that are pre-installed in SigNoz, for example:

Spring Boot Observability​

This dashboard provides details of one or more Spring Boot applications including the following:

  • The number of HTTP requests received by the application
  • A breakdown of which URL paths requests were received for
  • The average duration of requests by path
  • The number of exceptions encountered by the application
  • Details of 2xx (that is, successful) and 5xx (that is, exceptions) requests
  • The request rate per second over time, by path
  • Log messages from the service

You may adjust the time period and drill down into issues, and search the logs for particular messages. This dashboard is designed for Spring Boot 3.x applications. Some features may work for Spring Boot 2.x applications.

Here is an example of this dashboard displaying data for a simple application:

Spring Boot Observability Dashboard

Spring Boot Statistics​

This dashboard provides more in-depth information about services including the following:

  • JVM statistics like heap and non-heap memory usage, and details of garbage collection
  • Load average and open files
  • Database connection pool statistics (for HikariCP)
  • HTTP request statistics
  • Logging (logback) statistics

You may adjust the time period and drill down into issues, and search the logs for particular messages. This dashboard is designed for Spring Boot 3.x applications. Some features may work for Spring Boot 2.x applications.

Here is an example of this dashboard displaying data for a simple application:

Spring Boot Stats Dashboard

Oracle Database Dashboard​

This dashboard provides details about the Oracle Database including:

  • SGA and PGA size
  • Active sessions
  • User commits
  • Execute count
  • CPU count and platform
  • Top SQL
  • Wait time statistics by class

Here is an example of this dashboard:

Oracle Database Dashboard

Kube State Metrics Dashboard​

This dashboard provides details of the Kubernetes cluster including:

  • Pod capacity and requests for CPU and memory
  • Node availability
  • Deployment, Stateful Set, Pod, Job and Container statistics
  • Details of horizontal pod autoscalers
  • Details of persistent volume claims

Here is an example of this dashboard:

Kube State Metrics Dashboard

Apache APISIX Dashboard​

This dashboard provides details of the APISIX API Gateway including:

  • Total Requests
  • NGINX Connection State
  • Etcd modifications

Here is an example of this dashboard:

Apache APISIX Dashboard

Envoy Gateway Dashboard​

This dashboard provides details of the Envoy Gateway, including:

  • Requests by type
  • Gateway controller runtime operations
  • Gateway processes and work queue

Envoy Gateway Dashboard

In addition, the following dashboards are also pre-installed:

Helidon Main Dashboard​

Combined dashboard for Heap memory usage statistics about all Helidon SE and Helidon MP applications deployed in the cluster.

Helidon Main Dashboard

Helidon MP Details​

Details about CPU and Memory usage of Helidon MP applications along with statistics about HTTP/REST requests per JVM.

Helidon MP Dashboard

Helidon SE Details​

Details about Memory usage of Helidon SE applications along with statistics about HTTP/REST requests per JVM.

Helidon SE Dashboard

Helidon JVM Details​

JVM level details about Helidon applications, including statistics about Virtual Threads, CPU and Memory usage and HTTP requests.

Helidon JVM Dashboard

APM Metrics​

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

APM Dashboard

Kafka Server Monitoring Dashboard​

Details about Kafka brokers, topics, partitions, and consumers. For more details on Kafka monitoring configuration and metrics, see the Kafka Observability Guide.

Kafka Dashboard

Kubernetes Pod Metrics - Overall​

Aggregated view of CPU, Memory, FileSystem, and Network usage by pods.

Kubernetes Pod Metrics Overall

Kubernetes Pod Metrics - Detailed​

Detailed view of CPU, Memory, FileSystem, and Network usage by pods.

Kubernetes Pod Metrics Detailed

Kubernetes PVC Metrics​

Capacity and Usage statistics about Persistent Volume Claims in the cluster.

Kubernetes PVC Metrics

Kubernetes Node Metrics - Overall​

Aggregated view of CPU, Memory, FileSystem, and Network usage by Nodes in the cluster.

Kubernetes Node Metrics Overall Dashboard

Kubernetes Node Metrics - Detailed​

Detailed view of CPU, Memory, FileSystem, and Network usage by Nodes in the cluster.

Kubernetes Node Metrics Detailed Dashboard

DB Calls Monitoring​

Details about DB attributes from opentelemetry.

Host Metrics Dashboard

Host Metrics (k8s)​

This dashboard uses the system metrics collected from the hostmetrics receiver to show CPU, Memory, Disk, Network and Filesystem usage.

Host Metrics Dashboard

HTTP API Monitoring​

This dashboard is built on top of available HTTP attributes from opentelemetry and provides insights about endpoint level performance indicators for HTTP calls.

HTTP API Dashboard

JVM Metrics​

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

JVM Metrics Dashboard

NGINX (OTEL)​

Details about connections/requests being handled by the NGINX Ingress controller. This dashboard is relevant only when deprecated ingress-nginx is explicitly enabled.

Nginx Dashboard

MicroTx​

Details about Transaction Manager for Microservices component and statistics about participating transactions.

MicroTx Dashboard