Go HTTP Server Structured Logging: from boundary to verified row
Use Go HTTP Server Structured Logging at a controlled application boundary, keep the event contract small, and verify a known outcome before building aggregate views.
- 1
Choose the outcome
Go API reliability
- 2
Define the contract
route_template, method, and status_code
- 3
Instrument the boundary
Use the router pattern rather than r.URL.Path to avoid one group per resource identifier.
- 4
Verify the evidence
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.
Before you start
Prerequisites and boundaries
- The telemetry-go SDK initialized with a server-side key
- A response-writer wrapper that records the final status code
- Normalized route names from the application router
Delivery setup
Install and initialize server-side
Initialize telemetry.NewTelemetry once per process, or use an application-owned http.Client when you need context cancellation and an explicit timeout. Keep ingestion credentials out of browser bundles, client-visible environment variables, source control, logs, and exception messages.
Go module installation
go get github.com/telemetry-sh/telemetry-go- 1Prepare one reusable server-side delivery client with bounded network behavior.
- 2Add the outcome event at the success, failure, retry, or timeout boundary.
- 3Send controlled fixtures and inspect the stored rows before enabling an alert.
Snippet
Start with one structured event
Add this shape where the workflow completes, fails, or retries. Then build the dashboard from real fields.
Go HTTP Server Structured Logging event
startedAt := time.Now()
next.ServeHTTP(recorder, r)
status := "success"
if recorder.StatusCode >= 500 {
status = "failed"
}
_, err := telemetryClient.Log("api_request_completed", map[string]interface{}{
"route_template": routePattern,
"method": r.Method,
"status_code": recorder.StatusCode,
"status": status,
"latency_ms": float64(time.Since(startedAt).Microseconds()) / 1000,
"request_id": requestID,
})Event contract
route_template, method, and status_code
status, latency_ms, and request_id
service, environment, and release
Implementation checkpoints
Checkpoint 1
Use the router pattern rather than r.URL.Path to avoid one group per resource identifier.
Checkpoint 2
Capture panics and early exits in the same documented outcome model.
Checkpoint 3
Do not make ingestion errors overwrite the application response; report them through the service's diagnostic path.
Verification
Prove the event arrived
Run this after exercising known success and failure cases. Replace the fallback table name if your final event contract differs from the snippet.
Go HTTP Server Structured Logging verification query
SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;Implementation references
Review the event contract, data-safety guidance, and upstream primary documentation before enabling a new production path.
Production boundary
Keep the outcome event small and recoverable
This pattern provides
- A bounded, SQL-ready outcome beside the upstream workflow.
- Stable fields for dashboards, alerts, and cross-event correlation.
- A fixture-driven path for validating success, failure, retry, and timeout behavior.
This pattern does not provide
- An OTLP exporter, automatic collection pipeline, or replacement for detailed traces and diagnostic logs.
- Exactly-once delivery merely because the payload contains an event ID.
- Permission to collect raw provider payloads, user content, credentials, or regulated data.
Event schema starting points
Event contracts for this workflow
Review the row grain, emit boundary, required types, privacy classes, example payload, and validation checklist before adapting a query or snippet to production.
Related product capability
Continue this workflow in Alerts
Promote the reviewed reliability query into an owned threshold and response workflow.
Related SQL recipes
Answer the next question with SQL
Run the query against the structured fields from this workflow, inspect the example result, and turn a useful answer into a dashboard or alert.
Calculate API Error Rate by Route
Which API routes have the highest meaningful 5xx error rate?
Open recipeCalculate p50, p95, and p99 API Latency
Which endpoints have the worst tail latency?
Open recipeCompare API Reliability by Release
Which releases coincide with worse API errors or tail latency?
Open recipeBrowse by implementation family
Compare related integration patterns
Templates to pair with this integration
More integrations
Pino Structured Event Analytics
Pair Pino diagnostic logs with bounded Telemetry outcome events for Node.js request, job, and product reliability analysis.
Open guideNestJS Request and Workflow Telemetry
Instrument NestJS controllers and providers with normalized route outcomes, latency, errors, releases, and approved account context.
Open guideGoogle Cloud Run Telemetry
Track Cloud Run request and job outcomes, cold-start context, instance concurrency, retries, latency, and releases with application-owned structured events.
Open guide