https://github.com/silv-io/diapretty
Pretty print LocalStack diagnostics files
https://github.com/silv-io/diapretty
Last synced: 8 months ago
JSON representation
Pretty print LocalStack diagnostics files
- Host: GitHub
- URL: https://github.com/silv-io/diapretty
- Owner: silv-io
- Created: 2022-11-23T15:49:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-04-07T12:28:18.000Z (over 2 years ago)
- Last Synced: 2024-12-27T09:42:12.564Z (10 months ago)
- Language: Jinja
- Size: 37.1 KB
- Stars: 16
- Watchers: 1
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-localstack - diapretty
- awesome-localstack - diapretty
README
# diapretty - LocalStack diagnosis pretty printer
Users of [LocalStack](https://github.com/localstack/localstack) can create diagnostics reports via the diagnostics endpoint:
```shell
curl -s localhost:4566/_localstack/diagnose | gzip -cf > diagnose.json.gz
```
This report contains a lot of data, which can be a bit overwhelming.
`diapretty` helps with that, by taking all the data from the report and putting it into a nice to read HTML report which is automatically opened in your browser.
# Installation
Just do `pip install -e .` in this directory
# Usage
## Read existing diagnostics report
After installation, you can use diapretty like this:
```shell
python -m diapretty.main /path/to/diagnose.json.gz
```
## Start the server
To access the diagnosis report of your currently running localstack instance, install the server extra:
```shell
pip install -e '.[server]'
```
and run
```shell
python -m diapretty.server
```
Then navigate to http://localhost:4567 in your browser.
# Develop
Run `make install` to create a virtual environment and install developer dependencies.