synd-api 0.4.0

syndicationd backend api
Documentation 
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

# synd-api

syndicationd API service library

## Responsibility

`synd-api` is the transport boundary for syndicationd. It owns HTTP serving,
GraphQL schema wiring, authentication, request limits, shutdown, and
observability. Feed lifecycle behavior is delegated to `synd-registry`, and
SQLite storage adapters are provided by `synd-persistence`.

This crate is a library. The local daemon process is started through
`synd daemon serve`.

## OpenTelemetry

synd-api is instrumented with OpenTelemetry.

### Traces

graphql request traces is exported

### Metrics

Following metrics are exported

| Metrics               | Meter     | Description                          |
| ---                   | ---       | ---                                  |
| `http.server.request` | Counter   | http request traffic per status code |
| `graphql.duration`    | Histogram | graphql latency                      |
| `registry.reconcile`  | Counter   | feed registry reconciliation attempts |


## Features

| Feature                | Description                          | Default |
| --                     | ---                                  | ---     |
| `introspection`        | Enable graphql introspection         | false   |
| `opentelemetry-stdout` | Enable opentelemetry stdout exporter | false   |