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 readme_metrics import MetricsApiConfig, 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 |
allowed_http_hosts | A list of allowed http hosts for sending data to the ReadMe API. |
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.6.tar.gz
(8.1 kB
view hashes)
Built Distribution
Close
Hashes for readme_metrics-1.0.6-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 64259ae1681af6ef916fa54f6340d150c03d395f6d29e235f2865e4ce86b9412 |
|
MD5 | 368c095115a9b68243e7736518a8bed1 |
|
BLAKE2b-256 | a3df962a265f3f78b6b2db887598d986dbbed997544ef1c8149c3fc3790facaf |