How signoz/dashboards works
Project type and purpose
• This is an open-source “dashboard templates” repository for SigNoz, an observability platform.
• It does not contain a front-end or back-end application in the usual sense, but rather a collection of JSON dashboard definitions organized by service (MySQL, MongoDB, APM, etc.).
File structure
• Top-level folders correspond to each supported service. For example:
• apache-web-server/
• aws-rds/
• kubernetes-infra-metrics/
• llm-observability/
…and so on.
• Inside each folder:
• A .json file (or multiple versions) defining the dashboard.
• An optional README.md explaining the metrics and usage.
• An assets/ subdirectory containing sample screenshots.
• Root files include CONTRIBUTING, CODE_OF_CONDUCT, LICENSE, and README describing how to contribute new dashboards.
README for additional insights
• README.md lists all available dashboards and their use cases.
• It defines naming conventions (service-source-version.json).
• It describes the contribution workflow (create file, add README, add screenshots, PR).
Main components
a. Component: GitHub Repository
• Hosts JSON dashboard definitions.
• Contains CI/CD for validating JSON syntax and possibly automated releases (could be GitHub Actions).
b. Component: SigNoz Observability Platform
• Ingestion pipeline (OpenTelemetry collector, Prometheus scraper).
• Storage layer (e.g., ClickHouse).
• Query/API layer.
• UI Dashboard Engine (Angular/React-based front-end).
c. Component: Data Sources (Instrumented Applications & Infrastructure)
• Services like MySQL, Redis, Kubernetes, JVM apps, etc., emitting metrics via OTLP/Prometheus endpoints.
d. Component: End User / DevOps Engineer
• Browses the GitHub repository.
• Imports JSON into the SigNoz UI.
• Visualizes dashboards.
e. (Optional) CI/CD Pipeline
• Lint JSON dashboards.
• Deploy example dashboards to a demo SigNoz instance.
Relationships & interactions
• Data Sources → (OTLP/Prometheus) → SigNoz Ingestion Pipeline → Storage.
• User → (HTTP) → SigNoz UI/API.
• User → (Git clone / PR) → GitHub Repo.
• GitHub Repo → (CI/CD) → optionally publish versioned dashboards to a release or demo instance.
Architectural patterns and principles
• Separation of concerns:
• Dashboard definitions are decoupled from the SigNoz codebase.
• Versioned templates per service.
• Extensibility:
• New dashboards can be plugged in by dropping a new JSON and assets folder.
• Declarative configuration:
• Dashboards described entirely in JSON.
• Content-distribution:
• Static assets served from GitHub.
Relevant technologies, frameworks, libraries
• Git/GitHub for version control.
• JSON schema for dashboard definitions.
• SigNoz project (Go-based backend, ClickHouse storage, React/TypeScript front-end).
• OpenTelemetry Collector or Prometheus for metric ingestion.
• CI/CD (e.g., GitHub Actions) for linting and publishing.