core/.gomarkdoc.yml at main · go-coldbrew/core · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
output: "{{.Dir}}/README.md"
header: |+
  # ColdBrew

  [![CI](https://github.com/go-coldbrew/core/actions/workflows/go.yml/badge.svg)](https://github.com/go-coldbrew/core/actions/workflows/go.yml)
  [![Go Report Card](https://goreportcard.com/badge/github.com/go-coldbrew/core)](https://goreportcard.com/report/github.com/go-coldbrew/core)
  [![GoDoc](https://pkg.go.dev/badge/github.com/go-coldbrew/core.svg)](https://pkg.go.dev/github.com/go-coldbrew/core)
  [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

  **A Go microservice framework for building production-grade gRPC services with built-in observability, resilience, and HTTP gateway support.**

  ColdBrew powers 100+ microservices serving 70k+ QPS each in production. It provides a batteries-included foundation so you can focus on business logic instead of boilerplate.

  ## Packages

  ColdBrew is a collection of composable packages:

  | Package | Description |
  |---------|-------------|
  | **[core](https://github.com/go-coldbrew/core)** | gRPC server, HTTP gateway, health checks, Prometheus metrics, graceful shutdown |
  | **[interceptors](https://github.com/go-coldbrew/interceptors)** | Chained gRPC interceptors: logging, tracing, Prometheus, circuit breaking, retries |
  | **[errors](https://github.com/go-coldbrew/errors)** | Enhanced errors with stack traces, gRPC status codes, error notification |
  | **[log](https://github.com/go-coldbrew/log)** | Structured logging with pluggable backends (zap, logrus, go-kit) |
  | **[tracing](https://github.com/go-coldbrew/tracing)** | Distributed tracing: OpenTelemetry, OpenTracing, NewRelic |
  | **[options](https://github.com/go-coldbrew/options)** | Request-scoped key-value metadata via context |
  | **[grpcpool](https://github.com/go-coldbrew/grpcpool)** | Round-robin gRPC connection pool |
  | **[data-builder](https://github.com/go-coldbrew/data-builder)** | Dependency injection with automatic resolution and parallel execution |
  | **[workers](https://github.com/go-coldbrew/workers)** | Background worker lifecycle with panic recovery, restart, and tracing |

  ## Quick Start

  ```bash
  # Generate a new service from the template
  pip install cookiecutter
  cookiecutter gh:go-coldbrew/cookiecutter-coldbrew

  # Build and run
  cd YourApp
  make run
  ```

  Your service starts with gRPC on `:9090`, HTTP gateway on `:9091`, Prometheus metrics at `/metrics`, and health checks at `/healthcheck` and `/readycheck`.

  ## Documentation

  - **[docs.coldbrew.cloud](https://docs.coldbrew.cloud)** — Full documentation, guides, and integrations
  - **[Getting Started](https://docs.coldbrew.cloud/getting-started)** — Create your first service with cookiecutter
  - **[How-To Guides](https://docs.coldbrew.cloud/howto)** — Tracing, logging, metrics, error handling, and more

  ---

  ## API Reference