hub / github.com/pace/bricks

github.com/pace/bricks @v0.5.5

repository ↗ · DeepWiki ↗ · release v0.5.5 ↗ · + Follow

2,193 symbols 9,210 edges 250 files ⚖ MIT 1,097 documented · 50% 1 cross-repo links ● updated 6mo agov0.5.5 · 2025-07-02★ 178

Browse by type

⨍ Functions 1,579◇ Types & classes 614

What it actually does AI analysis from the code graph — generated when you open this

loading…

README

PACE Bricks

Opinionated microservice kit to help developers to build microservices with go.

Opinions

A pace/bricks microservice is:

built as a docker container
deployed into a kubernetes cluster
support for the termination log
configured using environment variables (TWELVE-FACTOR APP)
monitored using prometheus
reports errors to sentry
samples traces to sentry
logs to stdout using json deployed kubernetes otherwise human readable
offers health endpoints
built-in redaction of JWTs and card schemes
connects to backend services
postgres (logging, metrics, tracing, health)
redis (logging, metrics, tracing, health)
queue via redis (logging, metrics, tracing, health)
http (logging, metrics, tracing, retries)
s3 via http (logging, metrics, tracing, health)
couchdb via http (logging, metrics, tracing, retries, health)
grpc (logging, metrics, tracing, retries)
provides two commands control and daemon
provides a RESTful API
code is generated from the OpenAPIv3 spec
authenticated via OAuth2
encoded using json:api
that supports logging, tracing and metrics
optionally provides a GRPC API
code is generated from the protoc spec
that supports logging, tracing and metrics

Install

go get github.com/pace/bricks/cmd/pb

Usage

pb -h

Contributing

Read our contributors guide.

Requirements

A working go installation
A working git installation

Testing

Use make test to test without dependencies
Use docker-compose run testserver make integration to test with dependencies
Use make testserver to start a testserver that will be started with dependencies. In order to update the server one need to docker-compose restart testserver

Environment variables for the pb command

Variable	Description
`PACE_BRICKS_EDITOR`	The path to the editor that should be used for opening a project. Defaults to `$EDITOR`.
`PACE_BRICKS_PATH`	The path where new project should be created. Defaults to `$HOME/PACE`.

Extension points exported contracts — how you extend this code

GetTestResponseWriter (Interface)

* GetTestResponseWriter is a standard http.ResponseWriter extended with methods to generate the respective responses eas [36 …

tools/testserver/simple/open-api.go

HealthCheck (Interface)

HealthCheck is a health check that is registered once and that is performed periodically in the background. [6 implementers]

maintenance/health/servicehealthcheck/healthcheck.go

GetPumpResponseWriter (Interface)

* GetPumpResponseWriter is a standard http.ResponseWriter extended with methods to generate the respective responses eas [18 …

http/jsonapi/generator/internal/fueling/open-api_test.go

ChainableRoundTripper (Interface)

ChainableRoundTripper models a chainable round tripper [14 implementers]

http/transport/chainable.go

TokenIntrospecter (Interface)

TokenIntrospecter needs to be implemented for token lookup [4 implementers]

http/oauth2/introspection.go

Token (Interface)

Token represents an authentication token. [2 implementers]

http/security/helper.go

browse all types & interfaces →

Core symbols most depended-on inside this repo

↓ 37 filesWorkQueue

WorkQueue is a work queue implementation that respects cancellation using contexts

pkg/synctx/work_queue.go

↓ 37 filesCache

Cache is a common abstraction to cache bytes. It is safe for concurrent use.

pkg/cache/cache.go

↓ 36 filesLocale

Locale contains the preferred language and timezone of the request

locale/locale.go

↓ 35 filesExternalDependencyContext

ExternalDependencyContext contains all dependencies that were seen during the request livecycle

http/middleware/external_dependency.go

↓ 31 fileslenCallbackReader

lenCallbackReader is a reader that reports the total size before closing

maintenance/metric/jsonapi/jsonapi.go

↓ 23 filesCtx

Ctx returns the logger for the passed context

maintenance/log/log.go

browse all functions →

Shape

Function 826

Method 753

Struct 392

Interface 138

TypeAlias 64

FuncType 20

Languages

Go100%

Modules by API surface

http/jsonapi/generator/internal/poi/open-api_test.go490 symbols

http/jsonapi/generator/internal/pay/open-api_test.go125 symbols

http/jsonapi/generator/internal/fueling/open-api_test.go74 symbols

http/jsonapi/generator/internal/articles/open-api_test.go63 symbols

http/jsonapi/request_test.go48 symbols

http/jsonapi/generator/internal/poi/poi_test.go47 symbols

http/jsonapi/response_test.go37 symbols

maintenance/errors/error.go28 symbols

http/jsonapi/models_test.go24 symbols

http/jsonapi/generator/internal/pay/pay_test.go24 symbols

http/jsonapi/node.go21 symbols

http/jsonapi/generator/generate_handler.go21 symbols

Used by 1 indexed graphs manifest dependencies, hub-wide

github.com/CesiumGS/cesium

For agents

$ claude mcp add bricks \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

github.com/pace/bricks @v0.5.5

PACE Bricks

Opinions

Install

Usage

Contributing

Requirements

Testing

Environment variables for the pb command

Extension points exported contracts — how you extend this code

Core symbols most depended-on inside this repo

Shape

Languages

Modules by API surface

Used by 1 indexed graphs manifest dependencies, hub-wide

For agents

Ask about this repo answers extend the page