Go HTTP server structured logging

Test the integration

Send and verify events with Go HTTP server structured logging

Use Go HTTP server structured logging where your app knows the final result. Collect only the fields you need, then verify a test event before building charts.

1
Choose the outcome
Go API reliability
2
Define the contract
route_template, method, and status_code
3
Log the final result
Use the router pattern rather than r.URL.Path to avoid one group per resource identifier.
4
Check the stored event
Exercise a known fixture, then inspect api_request_completed for one correctly typed terminal row.

Before you start

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-http-install

Go module installation

bash

go get github.com/telemetry-sh/telemetry-go

1Create one reusable server-side client. Set its timeout and retry limit.
2Log an event when the operation succeeds, fails, retries, or times out.
3Send test events with known results 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

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 schema

route_template, method, and status_code

status, latency_ms, and request_id

service, environment, and release

Check your setup

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-verification

Go HTTP server structured logging verification query

sql

SELECT *
FROM api_request_completed
ORDER BY timestamp_utc DESC
LIMIT 20;

Confirm one terminal row per logical outcome, with the expected status, identifiers, units, and UTC time.

Inspect the inferred schema and verify that retries do not change field types or generate a new logical event ID.

Search the stored fields for credentials, raw payloads, prompts, private content, and unbounded error messages.

Exercise a provider timeout, ingestion rejection, and process shutdown before treating the dashboard as complete.

Implementation references

Review the event contract, data-safety guidance, and upstream primary documentation before enabling a new production path.

Go SDK Reliability by release SQL Go net/http package

Where to log

Keep the outcome event small and recoverable

This pattern provides

Record the outcome as an event you can query with SQL.
Stable fields for dashboards, alerts, and cross-event correlation.
Test events for checking success, failure, retries, and timeouts.

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.

Delivery and idempotency Batching and shutdown Troubleshoot ingestion

Example event schemas

Check what each event records, when to send it, and which field types it needs. Review the example payload and privacy checklist before using it in production.

API reliability10 fields