Skip to content

Commit

Permalink
Refactor README [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
draincoder committed Mar 4, 2024
1 parent e71f28f commit 3d5d2b1
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 19 deletions.
25 changes: 17 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,17 @@
## ASGI Monitor
[![license](https://img.shields.io/github/license/draincoder/asgi-monitor)](https://github.com/draincoder/asgi-monitor/blob/master/LICENSE)
[![test](https://github.com/draincoder/asgi-monitor/actions/workflows/ci.yaml/badge.svg)](https://github.com/draincoder/asgi-monitor/actions/workflows/ci.yaml)
[![PyPI version](https://badge.fury.io/py/asgi-monitor.svg)](https://pypi.python.org/pypi/asgi-monitor)
[![Supported versions](https://img.shields.io/pypi/pyversions/asgi-monitor.svg)](https://pypi.python.org/pypi/asgi-monitor)
[![downloads](https://img.shields.io/pypi/dm/asgi-monitor.svg)](https://pypistats.org/packages/asgi-monitor)

A library for easy and fast configuration of logging, tracing and monitoring of ASGI applications.
<div align="center">
<pictire>
<img alt="asgi-monitor logo" src="docs/images/logo.png" height="300">
</pictire>

<hr>

[![PyPI version](https://badge.fury.io/py/asgi-monitor.svg)](https://pypi.python.org/pypi/asgi-monitor)
[![Test](https://github.com/draincoder/asgi-monitor/actions/workflows/ci.yaml/badge.svg)](https://github.com/draincoder/asgi-monitor/actions/workflows/ci.yaml)
[![Supported versions](https://img.shields.io/pypi/pyversions/asgi-monitor.svg)](https://pypi.python.org/pypi/asgi-monitor)
[![Downloads](https://img.shields.io/pypi/dm/asgi-monitor.svg)](https://pypistats.org/packages/asgi-monitor)
[![License](https://img.shields.io/github/license/draincoder/asgi-monitor)](https://github.com/draincoder/asgi-monitor/blob/master/LICENSE)

</div>


### A library for easy and fast configuration of logging, tracing and monitoring of ASGI applications.
File renamed without changes
Binary file added docs/images/logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
15 changes: 4 additions & 11 deletions examples/real_world/README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,14 @@
## Start example in Docker
### Start example in Docker

```shell
docker compose -f examples/real_world/docker-compose.yaml --profile api --profile grafana up --build -d
```

## Stop example in Docker
### Stop example in Docker

```shell
docker compose -f examples/real_world/docker-compose.yaml --profile api --profile grafana down
```

## Grafana - http://127.0.0.1:3000/

### API Metrics dashboard
![Dashboard](./pictures/dashboard.png)

### Tempo traces from dashboard logs
![Traces](./pictures/traces.png)

## Swagger - http://127.0.0.1:8080/docs/
#### `Grafana:` http://127.0.0.1:3000/
#### `Swagger:` http://127.0.0.1:8080/docs/

0 comments on commit 3d5d2b1

Please sign in to comment.