Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/fike/fastapi-blog

A FastAPI backend for blog with OpenTelemtry and Jaeger
https://github.com/fike/fastapi-blog

docker fastapi instrumentation jaeger nextjs opentelemetry psotgresql pytest react sqlalchemy

Last synced: 7 days ago
JSON representation

A FastAPI backend for blog with OpenTelemtry and Jaeger

Host: GitHub
URL: https://github.com/fike/fastapi-blog
Owner: fike
License: mit
Created: 2021-02-10T15:01:02.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-01-20T22:09:43.000Z (10 months ago)
Last Synced: 2024-08-01T22:55:15.619Z (3 months ago)
Topics: docker, fastapi, instrumentation, jaeger, nextjs, opentelemetry, psotgresql, pytest, react, sqlalchemy
Language: Python
Homepage:
Size: 1.03 MB
Stars: 100
Watchers: 8
Forks: 18
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# A FastAPI sample

It's a FastAPI implementation as the backend for a blog system. This project's a funny goal to apply things that I'm learning. Things that you see here like telemetry using open source projects, CRUD using REST, and GraphQL (I hope that I have time to do that).

## Dependencies

* Poetry
* SQLAlchemy
* Alembic for migrations
* OpenTelemtry for instrumentation
* Docker
* Docker-Compose
* Jaeger
* Next.js
* React
* Make

## How to use

Use make command to run inside a docker container, it'll expose the port 8000 and access using URL: `http://localhost:8000`. I'm not sure if a makefile runs in the Powershell, probably yes but I suggest using [WSL2](https://docs.microsoft.com/windows/wsl/install-win10).

The frontend is in the early stage but you can see access: `http://localhost:3000/`.

**Up and run**:

```bash
make dev-up
```

!["Screenshot with REST backend endpoints"](/assets/fastapi_blog_endpoints.png)

This repo is instrumented by OpenTelemtry and export metric to Jaeger that starts together with the app by Docker-Compose, to access: `http://localhost:16686/`

### Tests

To run tests will up a PostgreSQL container and expose 5433 port to populate. The report will write in `htmlcov` dir.

```bash
make test-app
```

### Run and watch on the Jaeger things breaking

The FastAPI code here was OpenTelemetry instrumented and to export Traces to Jaeger. If you want to see a break simulation, follow the steps below.

#### Install dependencies

```bash
python -m venv .venv

pip install poetry

poetry install
```

#### Start FastAPI, PostgreSQL and Jaeger

```bash
make dev-up
```

[![asciicast](https://asciinema.org/a/395681.svg)](https://asciinema.org/a/395681)

#### Open another shell session and run `populate_posts.py` to create users and posts samples.

```bash
opentelemetry-instrument tests/populate_posts.py
```

[![asciicast](https://asciinema.org/a/395680.svg)](https://asciinema.org/a/395680)

#### Break things

Open a third shell session to stop Postgres, this will break the FastAPI app. You'll see error messages in the log and the script client on the console. Stop Postgres, wait some seconds or a minute, start Postgres again.

```bash
make dev-db-kill

sleep 30

make dev-db-start
```

[![asciicast](https://asciinema.org/a/395681.svg)](https://asciinema.org/a/395681)

#### Stop populate script

Stop the `populate_posts.py` scritpt (`ctrl+c`), go to Jaeger UI (http://localhost:16686/). If everything fine (or fail... 😁), you'll see on Jaeger like screenshots below.

* **FastAPI errors exported by OpenTelemetry to Jaeger**

!["jaeger traces errors"](/assets/jaeger_traces.png)

* **An error detail from the client request and server**.

!["an example of errors in the jaeger"](/assets/jaeger_trace_error.png)

## Known issues

* Some Opentelemetry warnings will show when tests ran.

## TODO

* ~~Pagination~~
* CORS
* Token authentication
* GraphQL
* Improve Token
* SAML/Oauth2
* Run tests in container
* ~~Autentication~~
* Implement UI (React)
* Helm Chart
* Improvement tests with tox
* ~~Implement a default path (**/**)~~
* Custom Limit and Offset
* ~~Add script to ingest samples~~
* ~~CI tests~~