How To

Step-by-step guides for building, running, and operating ColdBrew services. The guides are grouped by what you are trying to do — pick the one that matches your task.

Build

Designing and writing your service.

I want to… Read
Define gRPC + HTTP endpoints APIs
Set up gRPC connection pooling gRPC
Add structured logging Log
Handle errors with stack traces Errors
Customize the interceptor chain Interceptors
Use dependency injection Data Builder
Run background workers Workers
Add JWT / API key auth Authentication
Add custom HTTP marshalers or middleware HTTP Gateway Extensions
Use server, client, or bidi streaming Streaming RPCs
Wire a database connection pool Database
Cache reads with Redis or Valkey Cache
Consume Kafka or NATS messages Messaging

Operate

Running, observing, and shipping your service.

I want to… Read
Add distributed tracing Tracing
Expose Prometheus metrics Metrics
Debug requests in production Debugging
Handle graceful shutdown Signals
Deploy to Kubernetes Production
Manage readiness with workers Readiness Patterns

Integrate

Connecting ColdBrew to your local environment, repo, and dependencies.

I want to… Read
Serve Swagger/OpenAPI UI Swagger
Write tests and benchmarks Testing
Use private Go modules Private Modules
Set up local dev with Docker Local Development

Advanced

Tuning, optimization, and topics most readers can skip on first pass.

I want to… Read
Optimize protobuf serialization vtprotobuf

If you have a How To that you would like to share, please open an issue

Table of contents