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. Detailed performance metrics and transaction traces are collected once the scout-apm package is installed and configured.
Requirements
Python 2.7 or 3.4+.
Scout APM has integrations for the following frameworks:
- Bottle 0.12+
- Celery 3.1+
- Django 1.8+
- Dramatiq 1.0+
- Falcon 2.0+
- Flask 0.10+
- Huey 2.0+
- Nameko 2.0+
- Pyramid 1.8+
- RQ 1.0+
- Starlette 0.12+
For other frameworks, you can use the agent's instrumentation API. See the Python help docs for more information.
Quick Start
A Scout account is required. Signup for Scout.
pip install scout-apm
Bottle
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)
Django
# 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"
Falcon
import falcon from scout_apm.falcon import ScoutMiddleware scout_middleware = ScoutMiddleware(config={ "key": "[AVAILABLE IN THE SCOUT UI]", "monitor": True, "name": "A FRIENDLY NAME FOR YOUR APP", }) api = falcon.API(middleware=[ScoutMiddleware()]) # Required for accessing extra per-request information scout_middleware.set_api(api)
Flask
These instructions assume the app uses SQLAlchemy. If that isn't the case, remove the referencing lines.
from scout_apm.flask import ScoutApm from scout_apm.flask.sqlalchemy import instrument_sqlalchemy # Setup a flask 'app' as normal # Attach 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')
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...
Documentation
For full installation instructions, including information on configuring Scout via environment variables and troubleshooting documentation, see our Python docs.
Support
Please contact us at support@scoutapm.com or create an issue in this repo.
Project details
Release history Release notifications
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
| Filename, size | File type | Python version | Upload date | Hashes |
|---|---|---|---|---|
| Filename, size scout_apm-2.10.0-cp35-cp35m-manylinux1_i686.whl (68.0 kB) | File type Wheel | Python version cp35 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp35-cp35m-manylinux1_x86_64.whl (68.9 kB) | File type Wheel | Python version cp35 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp35-cp35m-manylinux2010_i686.whl (68.0 kB) | File type Wheel | Python version cp35 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp35-cp35m-manylinux2010_x86_64.whl (68.9 kB) | File type Wheel | Python version cp35 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp36-cp36m-manylinux1_i686.whl (70.5 kB) | File type Wheel | Python version cp36 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp36-cp36m-manylinux1_x86_64.whl (71.4 kB) | File type Wheel | Python version cp36 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp36-cp36m-manylinux2010_i686.whl (70.5 kB) | File type Wheel | Python version cp36 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp36-cp36m-manylinux2010_x86_64.whl (71.4 kB) | File type Wheel | Python version cp36 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp37-cp37m-manylinux1_i686.whl (71.4 kB) | File type Wheel | Python version cp37 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp37-cp37m-manylinux1_x86_64.whl (72.3 kB) | File type Wheel | Python version cp37 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp37-cp37m-manylinux2010_i686.whl (71.4 kB) | File type Wheel | Python version cp37 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp37-cp37m-manylinux2010_x86_64.whl (72.3 kB) | File type Wheel | Python version cp37 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp38-cp38-manylinux1_i686.whl (70.5 kB) | File type Wheel | Python version cp38 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp38-cp38-manylinux1_x86_64.whl (71.4 kB) | File type Wheel | Python version cp38 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp38-cp38-manylinux2010_i686.whl (70.5 kB) | File type Wheel | Python version cp38 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-cp38-cp38-manylinux2010_x86_64.whl (71.4 kB) | File type Wheel | Python version cp38 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0-py2-none-any.whl (54.0 kB) | File type Wheel | Python version py2 | Upload date | Hashes View hashes |
| Filename, size scout_apm-2.10.0.tar.gz (45.8 kB) | File type Source | Python version None | Upload date | Hashes View hashes |
Hashes for scout_apm-2.10.0-cp35-cp35m-manylinux1_i686.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b7898eabf51adeba924912c64624f603eed0874175f2ea5b28ddd579a667c109 |
|
| MD5 | d630fd87424e3eeea4b43977aea3fcef |
|
| BLAKE2-256 | 97bec1a6c2a9cc08cb8524b7eb415d9be45e189f469710633607e77b8d245f99 |
Hashes for scout_apm-2.10.0-cp35-cp35m-manylinux1_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 899e81682e1dc6177054199eb128eb1a3c5f3814f29751eb261883dba1a6cbee |
|
| MD5 | f4b7c882b0be30d13df7ff1dca39edec |
|
| BLAKE2-256 | ef6df7b0e8cd7d576d1d47e54d3b5e779d903e8893d44530ba2779732ee578b5 |
Hashes for scout_apm-2.10.0-cp35-cp35m-manylinux2010_i686.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 3711522ec5d30d22f5921492466034dfab604ebbe17ec10f2dedade4b4950921 |
|
| MD5 | 492f4a1aa83fcb2ecf8f1f20b7e7c8a0 |
|
| BLAKE2-256 | ff8d01d9f1d67d253a4abf389846b8baaaaf2c5cc1ad81fc31c62509745cec6f |
Hashes for scout_apm-2.10.0-cp35-cp35m-manylinux2010_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | b5c8160845b7906c885ef84546e494c0a889d947e82687e7d42ecdc988795e84 |
|
| MD5 | 9971904445b2587a0b68833845117404 |
|
| BLAKE2-256 | 20bbb44c56b1b5c1514a719317cfcab08c228c205ddbae0a39aba3e89761c620 |
Hashes for scout_apm-2.10.0-cp36-cp36m-manylinux1_i686.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c3c9010a2577121522a3bf6ea721bff5551627d5f394f861937608ea520dc201 |
|
| MD5 | 3153ad143af815858a399a6a6842c0a1 |
|
| BLAKE2-256 | 2c8bedc5a7d268213883c58712dee9fe6f5a3acb5de5a44602c79cd906331f88 |
Hashes for scout_apm-2.10.0-cp36-cp36m-manylinux1_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e29f5c4c99303fdf779f5da18ed68a80b64eb930daccb58f65b3d5dd08e6f413 |
|
| MD5 | 03084664755919cf90ee6c1078f3ab18 |
|
| BLAKE2-256 | 62da611f80cbde504e1e7bf862b695a56fb46caa488f51ba81e042bcb648e304 |
Hashes for scout_apm-2.10.0-cp36-cp36m-manylinux2010_i686.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | dd87ebf434ea4391aaf1574300d1d5a7f552397a0b551830778cfa43c05607c4 |
|
| MD5 | 7d5c735334ab49f688ff047756484ef5 |
|
| BLAKE2-256 | cce39bb8a2ff994199644194adefa755287d30016efe6fd0f4323cd1f468bdc6 |
Hashes for scout_apm-2.10.0-cp36-cp36m-manylinux2010_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 12d5d703a33f2acf3c2e6bc9c0ad759ad97407fffcf4effeb69028f29cf98fa0 |
|
| MD5 | b98b4dd52b7effb143b109783f6d73ac |
|
| BLAKE2-256 | c9b62723b316a003e5b37e133a04c02bd8474c80fa14fd322e229633015a8a83 |
Hashes for scout_apm-2.10.0-cp37-cp37m-manylinux1_i686.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 09e552e001f8bdeb271f98744def2eb5ea6e4adb3e67cdf0cbe17c76711e860b |
|
| MD5 | 5e28fa5866319b0761ef7993c7b22bf7 |
|
| BLAKE2-256 | 24672a21fbccf7266a27a4887793e57d23f3fe27450225f12114dcda8fd8c9cf |
Hashes for scout_apm-2.10.0-cp37-cp37m-manylinux1_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 2d5f6f1887de14dfa190278340053ba6ee3e528375cdc63f9580380e505dede8 |
|
| MD5 | 6ae00fc55aa545e02c5ce78cfe1b4b5c |
|
| BLAKE2-256 | 6dace6e48c1cd2a382c6f01efff908a92d59c69dbc916198feb0be901b4e1e2b |
Hashes for scout_apm-2.10.0-cp37-cp37m-manylinux2010_i686.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 891ceaca64fa5c7cb963f5580a8a983f6caf9a803cb1cfc62f2dcbed50675838 |
|
| MD5 | 3f5c168451c4384523ec2e1296d25dcd |
|
| BLAKE2-256 | 98d0ee332103f4f02786c6c61ed8e6ea50d2cfb82d2e545ff58d7f97fd98d3f8 |
Hashes for scout_apm-2.10.0-cp37-cp37m-manylinux2010_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | fba7ed1b6432d1c5d1903dd2d28a45f635a8dedd8e8d2d6650f0abc1fa0254c6 |
|
| MD5 | b7c8f8d0cd670bb9a5e919159a27ed3c |
|
| BLAKE2-256 | 1366762cf6d5fd30984e4d5c22d7cfda15e7e6cee66fb3d989d8933a6c6c3427 |
Hashes for scout_apm-2.10.0-cp38-cp38-manylinux1_i686.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 0342195f38751b732ef8994d00ae7d274ba5d6f71d47f68ba7734748a9bcb02c |
|
| MD5 | 58f4822de809f3b843cdc03cb05d876d |
|
| BLAKE2-256 | bbec51a0d2986c271d62b5612b19b25cea685a3dd3010cbcb490d5716a0d2e1a |
Hashes for scout_apm-2.10.0-cp38-cp38-manylinux1_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 79915e6c3df8857116c8995c9e84d677fd04c07dce7972f3dffe830fa70a2584 |
|
| MD5 | 20cd6d3e2a75dfa14565adb5117abe15 |
|
| BLAKE2-256 | 9ea1c42ddf20b1a9b792ed72dd8ab711a659f60f3a58fd3ec2e60d02ae922512 |
Hashes for scout_apm-2.10.0-cp38-cp38-manylinux2010_i686.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 340df4fb984092023fcef7cd36408756165c9fcddebb43f83de1b6ed5a704cec |
|
| MD5 | eea10b0931f2b6d78b24c42cbce93e26 |
|
| BLAKE2-256 | 860db702663646985734e30de95e469be99a82de93e7fb828b615283b0297e2a |
Hashes for scout_apm-2.10.0-cp38-cp38-manylinux2010_x86_64.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | bd79f14b71838cbdca2e1646c005ad6b7fbba949b577037645af7bb657bec322 |
|
| MD5 | 51b3b8b302b7e79853ad52610396627c |
|
| BLAKE2-256 | 52f2b43d6212a6fca26cd997671a60245af4135bbde0b10594cd4e1fe0a9d4a1 |
Hashes for scout_apm-2.10.0-py2-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 1871f7aa54dedff7a2d84d9c04dbe3f21b0ded1d3a4d0f49bd517ea92d389e38 |
|
| MD5 | 67d438c37dad11d9071ff25cc4798927 |
|
| BLAKE2-256 | d7c86df6d57e4decfee34b37c3623f244ab9b72c0f1e591b03266269c64e892a |