Scout Application Performance Monitoring Agent
Project description
# Scout Python APM Agent
Monitor the performance of Python Django apps, Flask apps, and Celery workers with Scout's [Python APM Agent](https://www.scoutapp.com). Detailed performance metrics and transaction traces are collected once the `scout-apm` package is installed and configured.
![screenshot](https://s3-us-west-1.amazonaws.com/scout-blog/python_monitoring_release/python_monitoring_screenshot.png)
## Requirements
Python Versions:
* Python 3.4+ ([request Python 2.7 support](https://github.com/scoutapp/scout_apm_python/issues/45))
Scout APM works with the following frameworks:
* Django 1.10+ ([request Django 1.8 and 1.9 support](https://github.com/scoutapp/scout_apm_python/issues/26))
* Flask 0.10+
* Celery 3.1+
* Pyramid 1.8+
* Bottle 0.12+
For frameworks not listed above, you can use the agent's instrumentation API. See the [Python help docs](http://help.apm.scoutapp.com/#python-agent) for more information.
## Quick Start
__A Scout account is required. [Signup for Scout](https://apm.scoutapp.com/users/sign_up).__
```sh
pip install scout-apm
```
### Django
```python
# settings.py
INSTALLED_APPS = (
'scout_apm.django', # should be listed first
# ... other apps ...
)
# Scout settings
SCOUT_MONITOR = True
SCOUT_KEY = "[AVAILABLE IN THE SCOUT UI]"
SCOUT_NAME = "A FRIENDLY NAME FOR YOUR APP"
```
### Flask
These instructions assume the app uses `SQLAlchemy`. If that isn't the case, remove the referencing lines.
```python
from scout_apm.flask import ScoutApm
from scout_apm.flask.sqlalchemy import instrument_sqlalchemy
# Setup a flask 'app' as normal
## Attaches ScoutApm to the Flask App
ScoutApm(app)
## Instrument the SQLAlchemy handle
instrument_sqlalchemy(db)
# Scout settings
app.config['SCOUT_MONITOR'] = True
app.config['SCOUT_KEY'] = "[AVAILABLE IN THE SCOUT UI]"
app.config['SCOUT_NAME'] = "A FRIENDLY NAME FOR YOUR APP"
```
### Pyramid
Add the `SCOUT_*` settings to the Pyramid config, and then `config.include('scout_apm.pyramid')`
```python
import scout_apm.pyramid
if __name__ == '__main__':
with Configurator() as config:
config.add_settings(
SCOUT_KEY = '...',
SCOUT_MONITOR = True,
SCOUT_NAME = 'My Pyramid App'
)
config.include('scout_apm.pyramid')
# Rest of your config...
```
### Bottle
```python
from scout_apm.bottle import ScoutPlugin
app = bottle.default_app()
app.config.update({'scout.name': "YOUR_APP_NAME",
'scout.key': "YOUR_KEY"
'scout.monitor': "true"})
scout = ScoutPlugin()
bottle.install(scout)
```
For full installation instructions, including information on configuring Scout via environment variables, see our [Python docs](http://help.apm.scoutapp.com/#python-agent).
## Documentation
For full installation and troubleshooting documentation, visit our
[help site](http://help.apm.scoutapp.com/#python-agent).
## Support
Please contact us at support@scoutapp.com or create an issue in this repo.
Monitor the performance of Python Django apps, Flask apps, and Celery workers with Scout's [Python APM Agent](https://www.scoutapp.com). Detailed performance metrics and transaction traces are collected once the `scout-apm` package is installed and configured.
![screenshot](https://s3-us-west-1.amazonaws.com/scout-blog/python_monitoring_release/python_monitoring_screenshot.png)
## Requirements
Python Versions:
* Python 3.4+ ([request Python 2.7 support](https://github.com/scoutapp/scout_apm_python/issues/45))
Scout APM works with the following frameworks:
* Django 1.10+ ([request Django 1.8 and 1.9 support](https://github.com/scoutapp/scout_apm_python/issues/26))
* Flask 0.10+
* Celery 3.1+
* Pyramid 1.8+
* Bottle 0.12+
For frameworks not listed above, you can use the agent's instrumentation API. See the [Python help docs](http://help.apm.scoutapp.com/#python-agent) for more information.
## Quick Start
__A Scout account is required. [Signup for Scout](https://apm.scoutapp.com/users/sign_up).__
```sh
pip install scout-apm
```
### Django
```python
# settings.py
INSTALLED_APPS = (
'scout_apm.django', # should be listed first
# ... other apps ...
)
# Scout settings
SCOUT_MONITOR = True
SCOUT_KEY = "[AVAILABLE IN THE SCOUT UI]"
SCOUT_NAME = "A FRIENDLY NAME FOR YOUR APP"
```
### Flask
These instructions assume the app uses `SQLAlchemy`. If that isn't the case, remove the referencing lines.
```python
from scout_apm.flask import ScoutApm
from scout_apm.flask.sqlalchemy import instrument_sqlalchemy
# Setup a flask 'app' as normal
## Attaches ScoutApm to the Flask App
ScoutApm(app)
## Instrument the SQLAlchemy handle
instrument_sqlalchemy(db)
# Scout settings
app.config['SCOUT_MONITOR'] = True
app.config['SCOUT_KEY'] = "[AVAILABLE IN THE SCOUT UI]"
app.config['SCOUT_NAME'] = "A FRIENDLY NAME FOR YOUR APP"
```
### Pyramid
Add the `SCOUT_*` settings to the Pyramid config, and then `config.include('scout_apm.pyramid')`
```python
import scout_apm.pyramid
if __name__ == '__main__':
with Configurator() as config:
config.add_settings(
SCOUT_KEY = '...',
SCOUT_MONITOR = True,
SCOUT_NAME = 'My Pyramid App'
)
config.include('scout_apm.pyramid')
# Rest of your config...
```
### Bottle
```python
from scout_apm.bottle import ScoutPlugin
app = bottle.default_app()
app.config.update({'scout.name': "YOUR_APP_NAME",
'scout.key': "YOUR_KEY"
'scout.monitor': "true"})
scout = ScoutPlugin()
bottle.install(scout)
```
For full installation instructions, including information on configuring Scout via environment variables, see our [Python docs](http://help.apm.scoutapp.com/#python-agent).
## Documentation
For full installation and troubleshooting documentation, visit our
[help site](http://help.apm.scoutapp.com/#python-agent).
## Support
Please contact us at support@scoutapp.com or create an issue in this repo.
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
scout_apm-1.3.1.tar.gz
(40.6 kB
view hashes)
Built Distributions
Close
Hashes for scout_apm-1.3.1-cp37-cp37m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5f89d6c5c4a6cbb7cb232f94b230c596d450623d2584de4c4e044f1b0c9a9957 |
|
MD5 | c00279e77b4c36417ed294218247883e |
|
BLAKE2b-256 | e9b78bef1e303be1b6b307e208d812dbff05ccc262296ee5a003c3a4736051a7 |
Close
Hashes for scout_apm-1.3.1-cp37-cp37m-manylinux1_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 712c782b1e5c1a7f902eabb6e1f4aea835d5b6461c39eafbdd6463e07603d4ad |
|
MD5 | 65b0daa702a27f3b25ea0c41a0f93fba |
|
BLAKE2b-256 | bc9e00466f63e20bcd442b07f1e7a67ac414509a28aeedc65f82d192b0f1dfbe |
Close
Hashes for scout_apm-1.3.1-cp36-cp36m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b0d7a537be28ea7505e8c3d680b8be8f8ed39b7f74355093ed7d686452275b64 |
|
MD5 | 8cfb7daa4f8e47f80492c8adfc99d800 |
|
BLAKE2b-256 | c0077854be4bfc56f8e74fe30df1656aab8e48412db6a663a152b06fb5397d61 |
Close
Hashes for scout_apm-1.3.1-cp36-cp36m-manylinux1_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f20e0c00298a71beb2a0ca6e6bfe6a9c7d19a89a76bb3cb888d7ea2a50992209 |
|
MD5 | 8c6f880e691e60eafc3e22cfc5518b1d |
|
BLAKE2b-256 | 6f0e8ce0575e2953aa3e2968433586343ab018822991724d6733a5e8d37940ae |
Close
Hashes for scout_apm-1.3.1-cp35-cp35m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2a290e2e907f37c2ccf42985fec6c0b794d80d5518056f694637d9f00d002fd7 |
|
MD5 | 44d2b5885e26b59bfcadf9305f02f915 |
|
BLAKE2b-256 | af8466a1f28791902d89e09bcdd3263c6fb7fc0e08de8a0dcfe014d5b7215a83 |
Close
Hashes for scout_apm-1.3.1-cp35-cp35m-manylinux1_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3f1a159a7109b354bb8016c91b3166f36fe8c6fa199a152bdc72241bd642b0d3 |
|
MD5 | 16154c492afc414a085b343f32651632 |
|
BLAKE2b-256 | 5162f9aa7b0c6232ffa3c2a1a53ce434a7509bdd7fe68efe1c8be7c15352a294 |
Close
Hashes for scout_apm-1.3.1-cp34-cp34m-manylinux1_x86_64.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6a2d3fff14b19649ddbef8760a11e275382a5ff68089907e7ad662d8f4538865 |
|
MD5 | 4caa9e5a786f85bf0066341c412dc544 |
|
BLAKE2b-256 | aebf8dfe3ff3e49e0e2d076dcbb1a6ec429ffbe48d00055df22b7c5727464b94 |
Close
Hashes for scout_apm-1.3.1-cp34-cp34m-manylinux1_i686.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 58635d279c79826d4b72d9e89c02e18b812d691f945c5595e06c684df53f3ca1 |
|
MD5 | b95d947793c077899e6b04105844aa1f |
|
BLAKE2b-256 | 0fdf366e26032346c77d991b795d91d1fd479183284bd545c0053c8293b71a70 |