Metadata-Version: 2.1
Name: shopcloud-django-instrumenting
Version: 1.3.0
Summary: Django tool for instrumenting
Home-page: https://github.com/Talk-Point/shopcloud-django-instrumenting
Author: Konstantin Stoldt
Author-email: konstantin.stoldt@talk-point.de
License: MIT
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: Django <6.0,>=3.2
Requires-Dist: djangorestframework

# Instrumenting

## install

- install with your favorite Python package manager

```sh
pip3 install shopcloud-django-instrumenting
```

### LogRequestMiddleware

add additional Information from request in AppEngine to Log

#### usage

add to MIDDLEWARE in django-app settings.py:

```python
MIDDLEWARE = [
    ...
    'shopcloud_django_instrumenting.middleware.LogRequestMiddleware',
]
```

## tracing

```py
from shopcloud_django_instrumenting import tracing

tr = tracing.Tracer('name_of_service', 'name_of_operation')
with tr.start_span('event.processing') as span:
    pass

data = tr.close()
```

## deploy

```sh
$ rm -rf build dist
$ pip3 install wheel twine
$ python3 setup.py sdist bdist_wheel
$ twine upload dist/*
```

## develop

```sh
$ pytest
$ pip3 install coverage
# shell report
$ coverage run -m pytest  && coverage report --show-missing
# html report
$ coverage run -m pytest  && coverage html
$ cd htmlcov
$ python3 -m http.server
```
