Portal Community

What You Will Set Up

OTel Collector

Central telemetry fan-out. Receives OTLP from all BizFirstGO services on ports 4317/4318 and routes signals to Loki, Prometheus, and Tempo.

Loki

Log aggregation. Stores structured logs from all BizFirstGO services. Queried via LogQL in Grafana Explore and the Logs panels.

Prometheus

Metrics scraping and storage. Pulls /metrics endpoints from all services on a 15-second interval. Queried via PromQL.

Tempo

Distributed tracing. Receives trace spans via OTLP. Stores traces with S3-compatible object storage. Queried via TraceQL.

Grafana

Unified observability UI. Connects to all three backends. Hosts pre-built BizFirstGO dashboards, Explore, and alerting.

BizFirstGO Services

ProcessEngine, EdgeStream, Octopus — configured with 3 environment variables to send telemetry to the OTel Collector.

Setup Sequence

1

Verify prerequisites

Docker 24+ or Kubernetes 1.28+, 4 CPU / 16 GB RAM minimum, ports 3000/4317/4318/3100/9090/3200 available. Prerequisites page

2

Start the observability stack

docker compose up -d starts all components. Grafana available at http://localhost:3000 within ~30 seconds. Install the Stack

3

Configure BizFirstGO services

Set 3 environment variables on each BizFirstGO service: OTEL_EXPORTER_OTLP_ENDPOINT, OTEL_SERVICE_NAME, OTEL_RESOURCE_ATTRIBUTES. Configure Services

4

Verify telemetry is flowing

Start one workflow execution. Check for logs in Loki, trace in Tempo, scrape target in Prometheus. Verify Ingestion

5

Import pre-built dashboards

Import the 10 BizFirstGO dashboard JSON files into Grafana. Set $tenant and $environment variables. Import Dashboards

6

Configure at least one alert contact point

Add a Slack webhook or email contact point. Import the BizFirstGO alert rules. Test fire an alert. Configure Alerts

7

Run the validation checklist

10 end-to-end validation checks to confirm the stack is production-ready. Validation Checklist

Estimated Setup Time

PhaseTimeNotes
Stack startup (Docker Compose)15 minutesIncludes image pull time on first run
BizFirstGO service configuration30 minutesPer service; env vars + restart
Ingestion verification15 minutesRun one execution, check 3 signals
Dashboard import20 minutes10 JSON files + variable configuration
Alert configuration20 minutesContact point + import alert rules
Validation checklist15 minutes10 checks
Total~2 hoursFor a single engineer from scratch
Prerequisites Before Starting

Read Guide1_PhysicalArchitecture and Guide2_DefaultArchitecture before this setup guide. Understanding the architecture helps you troubleshoot when signals are not flowing as expected.