Operational Tooling¶

Overview of all operator and developer tools deployed alongside the Forma3D.Connect platform.

Runtime Tools (Deployed Containers)¶

These run as Docker containers on the staging/production droplet and are accessible via Traefik.

Uptime Kuma¶

Uptime Kuma probes the Gateway /health endpoint at regular intervals and provides a public-facing status page. When a service goes down, it sends notifications via SMTP (and optionally Telegram/Slack).

Dozzle¶

Dozzle provides a lightweight web UI to tail container logs in real time. It reads directly from the Docker daemon via a read-only socket mount — it does not participate in the application's data flow, which is why it appears in the Deployment diagram but not the Container diagram.

pgAdmin¶

pgAdmin provides a web-based UI for direct PostgreSQL access. Used for ad-hoc queries, schema inspection, data corrections, and database maintenance tasks.

Grafana¶

Grafana queries structured logs from ClickHouse and provides dashboards for log analysis, error rate monitoring, and alerting rules.

Documentation Tools (Static Sites)¶

These are deployed as static sites and do not interact with the running system at runtime. They are not included in C4 architecture diagrams.

Zensical¶

Zensical hosts all project documentation from the docs/ folder, providing a searchable and navigable documentation site for the team.

EventCatalog¶

EventCatalog documents the event-driven communication between microservices — domains, events, commands, queries, and service ownership. It provides a visual catalog of how services interact through Redis/BullMQ.

CI/Pipeline Tools¶

These tools run during CI/CD pipeline execution only. They are not deployed as containers on the staging/production droplet.

CodeCharta¶

CodeCharta generates a merged .cc.json from SonarCloud metrics and git history during the GenerateCodeCharta pipeline job. The file is published as a pipeline artifact and then deployed by the DeployCodeCharta job, which SCPs it to the staging server's bind-mount volume (/opt/forma3d/codecharta/). The docs container mounts this directory read-only and serves the file at /codecharta/ with CORS headers and Cache-Control: no-cache, so browsers always revalidate and pick up new versions without a container restart.

Usage:

1. Download the .cc.json file from https://staging-connect-docs.forma3d.be/codecharta/forma3d.cc.json (or via the "Codebase City Map" link in Settings → Help & Support)
2. Open the CodeCharta Web Studio
3. Drag-and-drop the downloaded file into the Web Studio

Note: The shareable ?file=URL approach does not work because CodeCharta's Content-Security-Policy (default-src 'self') blocks XHR requests to external origins. A future self-hosted visualization (Option D) would restore shareable URLs.

Related: CodeCharta Research | ADR-066 | Pipeline Reference

Tool Classification¶

Why some tools appear in C4 diagrams and others don't: