stackify-python-apm 1.12.2

This is the official Python module for Stackify Python APM.

Stackify Python APM

Installation Guide

Django Setup

1. Install Stackify Linux Agent.

2. Check that your setup meets our system requirements.

   • Python Versions 2.7 - 3.7
   • Django Versions 1.7 - 2.x

3. Install the Stackify Python APM agent using pip:

   $ pip install stackify-python-apm
   

   You may install your stackify-python-apm by adding it to your project's requirements.txt file.

4. Add stackifyapm.contrib.django to INSTALLED_APPS in your settings:

   INSTALLED_APPS = ( # ... 'stackifyapm.contrib.django', )
   

5. Add our tracing middleware to your MIDDLEWARE settings:

   MIDDLEWARE = ( 'stackifyapm.contrib.django.middleware.TracingMiddleware', # ... )
   

6. Customize Application Name and Environment configuration:

   APPLICATION_NAME = 'Python Application'
   ENVIRONMENT = 'Production'
   

   or

   STACKIFY_APM = {
       'APPLICATION_NAME': 'Python Application',
       'ENVIRONMENT': 'Production',
   }
   

Flask Setup

1. Install Stackify Linux Agent.

2. Check that your setup meets our system requirements.

   • Python Versions 2.7 - 3.7
   • Flask Versions 0.7 - 1.0

3. Install the Stackify Python APM agent using pip:

   $ pip install stackify-python-apm
   

   You may install your stackify-python-apm by adding it to your project's requirements.txt file.

4. Update and insert the apm settings to your application:

   from stackifyapm.contrib.flask import StackifyAPM
   
   app = Flask(...)
   StackifyAPM(app)
   

5. Customize Application Name and Environment configuration:

   app.config['APPLICATION_NAME'] = 'Python Application'
   app.config['ENVIRONMENT'] = 'Production'
   
   StackifyAPM(app)
   

   or

   STACKIFY_APM = {
       'APPLICATION_NAME': 'Python Application',
       'ENVIRONMENT': 'Production',
   }
   
   StackifyAPM(app, **STACKIFY_APM)
   

Pyramid Setup

1. Install Stackify Linux Agent.

2. Check that your setup meets our system requirements.

   • Python Versions 2.7 - 3.7
   • Pyramid Versions 1.4 - 1.10

3. Install the Stackify Python APM agent using pip:

   $ pip install stackify-python-apm
   

   You may install your stackify-python-apm by adding it to your project's requirements.txt file.

4. Update and insert the apm settings to your application:

   Include our pyramid tween integration

   with Configurator() as config:
       config.include('stackifyapm.contrib.pyramid')
   

   Or explicit tween configuration

   with Configurator(settings={
       'pyramid.tweens': ['stackifyapm.contrib.pyramid.stackifyapm_tween_factory'].
   }) as config:
       ...
   

5. Customize Application Name and Environment configuration:

   STACKIFY_APM = {
       'APPLICATION_NAME': 'Python Application',
       'ENVIRONMENT': 'Production',
   }
   
   with Configurator(settings=STACKIFY_APM) as config:
       config.include('stackifyapm.contrib.pyramid')
   

Standalone Setup

1. Install Stackify Linux Agent.

2. Install the Stackify Python APM agent using pip:

   $ pip install stackify-python-apm
   

   You may install your stackify-python-apm by adding it to your project's requirements.txt file.

3. Update and insert the apm settings to your application:

   from stackifyapm.contrib import StackifyAPM
   
   StackifyAPM()
   

4. Customize Application Name and Environment configuration:

   STACKIFY_APM = {
       'APPLICATION_NAME': 'Python Application',
       'ENVIRONMENT': 'Production',
   }
   
   StackifyAPM(**STACKIFY_APM)