In this tutorial, you will import the backend app source code into your local development environment, add the Sentry SDK, and initialize it.
The demo app source code requires a Python development environment to build, install, and run the application. Make sure that you have the following in place:
To start monitoring errors in your application you'll need to create a newprojectRepresents your service in Sentry and allows you to scope events to a distinct application.in your Sentry account. Check out our frontend tutorial to learn more about how to create a project and define alert rules.
Open the sample code repository on GitHub.
Click on "Fork" and select the target GitHub account you wish this repository to be forked in to.
Once the fork is complete, click on "Clone or download" and copy the repository URL. You can do this using HTTPS, SSH or via GitHub CLI.
Clone the forked repository to your local environment:Copied
> git clone <repository HTTPS or SSH url>
Now that the sample code is available locally, open the
backend-monitoringprojectRepresents your service in Sentry and allows you to scope events to a distinct application.in your preferred code editor.
Sentry can help you resolve your errors faster by suggesting a suspect commit that might have introduced the error into your codebase. This is enabled by configuring commit tracking. Integrating your source code management solution and adding your code repositories is required to enable commit tracking. Learn more in our releases documentation.
- Open your Sentry account and navigate to Settings > Integrations to enable the GitHub integration and add your
backend-monitoringrepository. For more detailed information, follow the steps described in our GitHub documentation.
Sentry captures data by using a platform-specific SDK within your application runtime. To use the SDK, import, initialize, and configure it in your source code.
To start working with the SDK in our Django app, we install the
sentry-sdkby defining the dependency in the
requirements.txtfile. The SDK documentation and release information are available in the Sentry SDK GitHub repository.
settings.pyfile (located under
_./backend-monitoring/myproject/settings.py). This is where we initialize and configure the Sentry SDK in our application.
After importing the Sentry SDK to the app, it is important to import the Sentry Django integration as well. Integrations extend the functionality of the SDK for some common frameworks and libraries.Copied
import sentry_sdk from sentry_sdk.integrations.django import DjangoIntegration
In the Sentry SDK configuration, enter the
DSNkey value you copied from theprojectRepresents your service in Sentry and allows you to scope events to a distinct application.created in the project creation tutorial.Copied
sentry_sdk.init( dsn="YOUR_DSN", integrations=[DjangoIntegration()], )
To build and run the demo application on your localhost:
Open a shell terminal and change directory to the
backend-monitoringprojectRepresents your service in Sentry and allows you to scope events to a distinct application.root folder.
If you haven't installed Python3, do so by running the following:Copied
brew install python3
pip3 install virtualenv virtualenvwrapper echo "source /usr/local/bin/virtualenvwrapper.sh" >> ~/.bashrc exec bash
Install Sentry's command-line tool to use release tracking and GitHub integration for commit data:Copied
npm install -g @sentry/cli
Setup and activate a Python 3 virtual environment in the project root.Copied
mkvirtualenv --python=python3 sentry-demo-django
You can name the virtual environment whatever you need for your project. In our case, we named it "sentry-demo-django".
To activate the virtual environment, run:Copied
Makefileincluded in the project's root folder. The file is used here to mimic a CI/CD flow.
deploytarget execution flow.
Notice that in addition to installing Python requirements and running the server, we also use the
sentry-clito create a new Sentry release, and associate commits to that release. Sentry will lookup through those commits when suggesting a suspect commit for your project issues. Commands mentioned within the
Makefilewill be explained in detail in the next part of the tutorial, Configuration Options.
To execute the
sentry-clicommands, follow the instructions described here to obtain the values for your
The sentry-cli can be configured by providing these values either through environment variables or through a dedicated configuration file. Learn more in Sentry CLI > Configuration and Authentication.
Run the following command to install the required Python libraries, set up the Sentry Release, and run the Django server:Copied
In the terminal, notice that a new release is created and commits are associated with it. Once the deploy finishes successfully, you'll see the confirmation in your terminal