Skip to main content
This documentation walks you through the steps needed to add the AppSignal package to your application. New to AppSignal? We recommend following our installation guide first.

​
Requirements

Before you can run AppSignal, make sure your application’s Operating System is supported.

​
Installation

First, sign up for an AppSignal account and add the AppSignal for Python integration package to your requirements.txt file:
If you want to enable distributed tracing and logging, send your data through an AppSignal Collector by setting two options:
  • collector_endpoint: your collector’s base URL. Create a collector on the “Hosted Collector” page in your organization’s settings and copy its “Collector URL”, or deploy your own. Distributed tracing needs a hosted collector.
  • service_name: names this application in distributed traces, so a trace that crosses several services shows which one did what. Use a different value for each service.
Then, install the package and run our automated install tool, which will create an __appsignal__.py file in your project:
If the pip and python executables do not work, please use the pip3 and python3 executables instead. The install tool does not add the collector options. Add collector_endpoint and service_name to the __appsignal__.py file it creates, as shown in the collector configuration guide.

​
Manual installation

You can also skip the automated tool and create the __appsignal__.py file manually:

​
Installing instrumentation packages

The AppSignal package does not automatically instrument any libraries. AppSignal offers support for a number of popular Python libraries, you can learn more about how to instrument these libraries in our Instrumentations documentation:

​
Configuration

After installing AppSignal and all necessary packages, you can read the Configuration documentation to learn how to report data to AppSignal.