aboutsummaryrefslogtreecommitdiffstats
path: root/lib/warden-stack/README.md
blob: 12f9f3a6400ab8b858b604204bdc3d664026155b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
warden-stack!

A crate centralising the configuration and initialisation of various services I find myself using in a lot of projects.

# TL:DR
Find a feature, activate it, initialise it in your builder, then you're good to go

## Features

Each feature unlocks configuration methods on the `ServicesBuilder`, allowing you to selectively wire up what you need.

| Feature        | Description                                               |
|----------------|-----------------------------------------------------------|
| `api`          | Enables `port` configuration     |
| `cache`        | Enables redis/valkey caching support   |
| `nats-core`    | Enables core NATS messaging via `async-nats`             |
| `nats-jetstream`| Enables NATS JetStream support via `async-nats`         |
| `opentelemetry`| Enables distributed tracing with OpenTelemetry           |
| `postgres`     | Enables PostgreSQL support using `sqlx`                  |
| `tracing`      | Enables tracing setup via `tracing` and `tracing-subscriber` |
| `opentelemetry-tonic`        | Enables opentelemetry injector and extractor utilities for `tonic`                    |
| `tracing-loki` | Enables tracing output to Loki.                           |