Metadata-Version: 2.1
Name: readme-metrics
Version: 1.0.0
Summary: ReadMe API Metrics WSGI SDK
Home-page: https://github.com/readmeio/metrics-sdks/tree/master/packages/python
Author: ReadMe
Author-email: support@readme.io
License: UNKNOWN
Platform: UNKNOWN
Description-Content-Type: text/markdown
Requires-Dist: werkzeug
Requires-Dist: requests

# readme-metrics

Track your API metrics within ReadMe.

[![](https://d3vv6lp55qjaqc.cloudfront.net/items/1M3C3j0I0s0j3T362344/Untitled-2.png)](https://readme.io)

## Installation

```
pip install readme-metrics
```

## Usage

Just include the MetricsMiddleware into your API!

```python
from metrics.MetricsApiConfig import MetricsApiConfig
from metrics.MetricsMiddleware import MetricsMiddleware

app = Flask(__name__)

app.wsgi_app = MetricsMiddleware(
    app.wsgi_app,
    MetricsApiConfig(
        README_API_KEY,
        lambda req: {
            'id': 'unique id of user making call',
            'label': 'label for us to show for this user (ie email, project name, user name, etc)',
            'email': 'email address for user'
        },
    )
)
```


### Configuration Options
There are a few options you can pass in to change how the logs are sent to ReadMe. These can be passed in MetricsApiConfig`.

Ex)

```python
MetricsApiConfig(
    README_API_KEY,
    lambda req: {
        'id': 'unique id of user making call',
        'label': 'label for us to show for this user (ie email, project name, user name, etc)',
        'email': 'email address for user'
    },
    buffer_length: 1,
    blacklist: 'credit_card' # Prevents credit_card in the request from being sent to readme
)

```

| Option | Use |
| :--- | :--- |
| development_mode | **default: false** If true, the log will be separate from normal production logs. This is great for separating staging or test data from data coming from customers |
| blacklist | **optional** An array of keys from your API requests and responses headers and bodies that you wish to blacklist from sending to ReadMe.<br /><br />If you configure a blacklist, it will override any whitelist configuration. |
| whitelist | **optional** An array of keys from your API requests and responses headers and bodies that you only wish to send to ReadMe. |
| buffer_length | **default: 10** Sets the number of API calls that should be recieved before the requests are sent to ReadMe |


