Dashboards and monitoring assets

Observability assets are generated per service and provisioned consistently in Compose and Kubernetes.

When to use

Use this reference when generating, reviewing or operating a Service Architect project.

Every service receives Jsonnet dashboard sources for the runtime capabilities represented by the graph.
generate.generated.sh compiles dashboards for provisioning.
Project-level grafana/provisioning connects generated dashboards and data sources.
prometheus.yml defines the local Compose scrape topology.
Helm ServiceMonitor or OTLP collector wiring supplies the equivalent Kubernetes metrics path.

Generated observability sources and provisioning.

FileDashboardDescription

<service>/grafana/dashboards/01_service.jsonnetService

Lifecycle, health and request overview.

02_streams.jsonnetStreams

Stream throughput, latency and errors.

03_datasource.jsonnet + 04_datasink.jsonnetConnectors

Inbound and outbound connector behavior.

05_pools.jsonnetExecution

Task pool utilization and queue behavior.

06_storage.jsonnetState

Storage-related runtime metrics.

07_http_server.jsonnet + 08_http_client.jsonnetHTTP

Server/client request metrics.

09_grpc_server.jsonnet + 10_grpc_client.jsonnetgRPC

Server/client RPC metrics.

11_runtime.jsonnetRuntime

Language/runtime process metrics.

12_kafka_client.jsonnetKafka

Producer and consumer metrics when Kafka is selected.

_lib.libsonnetShared dashboard library

Canonical labels, panels and queries.

grafana/generate.generated.shGenerated executable

Compile the service dashboard set.

grafana/provisioning/Project provisioning

Load dashboards and data sources into local Grafana.

prometheus.ymlManaged

Compose scrape and remote telemetry configuration.

make grafana-dashboards
make docker-up
# or deploy the same service identity
make kubernetes-up