ReadMe API Metrics WSGI SDK
Project description
readme-metrics
Track your API metrics within ReadMe.
Installation
pip install readme-metrics
Usage
Just include the MetricsMiddleware into your API!
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)
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. 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 |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
readme-metrics-1.0.0.tar.gz
(7.4 kB
view hashes)
Built Distribution
Close
Hashes for readme_metrics-1.0.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | dfbb784595c319fd22648ce5688425e01b016e02cf4ea0bb01649effe0865f4f |
|
MD5 | 4d9b5db004152e71ade1a81e364b6c43 |
|
BLAKE2b-256 | 634ebdb5b430bd5d1a9906d42b415a0bc661485778024ca4e967017760eb35b8 |