ShipSolid Observability Platform
Documentation hub for the ShipSolid observability platform — Grafana Cloud (Mimir / Loki / Tempo) as the data plane, OpenTelemetry as the instrumentation standard, Grafana Alloy as the universal collector, all driven by Helm + Terraform.
This is the scope: platform project workspace. Curated, schema-governed artifacts (ADRs, RFCs,
TDDs, runbooks) still live in the repo’s top-level curated surfaces; sections here either hold
platform-local working docs or index the canonical surfaces filtered to ShipSolid scope.
Sections
| # | Section | What lives here | | --- | -------------------------------------------------------------------------------- | -------------------------------- | ----------------------------------------------------------------- | | 00 | Start Here | Vision, charter, 30-minute onboard, glossary | | 01 | Platform Architecture | C4 views, data/control plane, signal catalog, ADR/RFC/TDD indexes | | 02 | Service Onboarding | Instrumentation guides, label schema, service catalog | | 03 | Reliability Engineering | SRE charter, SLOs, error budgets, PRR | | 04 | Operations & Incident Response | On-call, IR playbook, runbooks, post-mortems | | 05 | Platform Configuration | Collector configs, alert/dashboard catalogs, sampling/retention | | 06 | Build & Release | Dev setup, CI/CD, release, rollback | | 07 | Cost & Governance | Ingest budgets, cardinality governance, vendor registry | | 08 | Strategy & Planning | Roadmap, OKRs, portfolio initiatives | | 09 | Archive | Historical releases, deprecated designs, retired services | | 10 | Templates | ADR/RFC/runbook/post-mortem/Confluence authoring templates |
Applications
Per-app documentation for individual ShipSolid apps — bounded to one service/repo, not a cross-cutting platform phase like the sections above.
| Application | What lives here | | ---------------------------------- | --------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | | signal-forge | Full docs for the signal-forge OTel microservices validation lab — architecture, services, API, deployment, observability, ops runbooks, ADRs |
Conventions
- All filenames kebab-case (no spaces,
&, or parentheses) per _meta/naming-conventions.md. The human-readable name is preserved in each page’stitle:frontmatter and H1. scope: platformacross this hub — it is all ShipSolid-origin content.- ADR/RFC numbering follows the repo’s global sequence with a
-shipsolidsuffix on ShipSolid-scoped slugs; those pages index the canonical top-level adrs/, rfcs/, and technical-designs/ surfaces. - Most pages are boilerplate stubs — search doc-debt with
grep -rn '\[stub' 1-projects/shipsolid/.
Local graph
Related notes
Replication Guides: Instrumenting Your Own Project
Step-by-step, copy-paste guides for replicating SignalForge's OpenTelemetry instrumentation pattern in a new .NET/Python/Angular/RabbitMQ/K8s project.
Guide: Collector & Pipeline Setup
Step-by-step: stand up a Grafana Alloy + grafana/k8s-monitoring Helm chart pipeline that receives OTLP traces/metrics/logs from your services and exports to Grafana Cloud or a self-hosted backend.
Guide: .NET Instrumentation
Step-by-step: instrument an ASP.NET Core / gRPC .NET 8 service with OpenTelemetry — SDK wiring, custom spans and metrics, and RabbitMQ producer-side async trace propagation via the outbox pattern.
Guide: Python Instrumentation
Step-by-step: instrument a Python FastAPI service with OpenTelemetry — SDK wiring, custom metrics, and RabbitMQ consumer-side async trace propagation via manual context extraction and SpanLink.