juice10 / appsignal-python

🟦 AppSignal for Python package

AppSignal for Python

AppSignal solves all your Python monitoring needs in a single tool. You and your team can focus on writing code and we'll provide the alerts if your app has any issues.

• AppSignal.com website
• Documentation
• Support

Description

The AppSignal package collects exceptions and performance data from your Python applications and sends it to AppSignal for analysis. Get alerted when an error occurs or an endpoint is responding very slowly.

Usage

First make sure you've installed AppSignal in your application by following the steps in Installation.

AppSignal will automatically monitor requests, report any exceptions that are thrown and any performance issues that might have occurred.

You can also add extra information by adding custom instrumentation and by tags.

Installation

Please follow our installation guide in our documentation. We try to automatically instrument as many packages as possible, but may not always be able to. Make to sure follow any instructions to add manual instrumentation.

Development

AppSignal for Python uses Hatch to manage dependencies, packaging and development environments.

pip install hatch

Publishing

Publishing is done using mono. Install it before development on the project.

mono publish

Linting and type checking

hatch run lint:all

hatch run lint:fmt # auto-formatting only
hatch run lint:style # style checking only
hatch run lint:typing # type checking only

Running tests

hatch run test:pytest

Running the CLI command

hatch shell
appsignal

Building wheels

hatch run build:all # for all platforms
hatch run build:me # for your current platform
hatch run build:for <triple> # for a specific agent triple

Custom agent build

hatch run build:me /path/to/agent
# or place the desired agent binary at
# `src/appsignal/appsignal-agent`, and then:
hatch run build:me --keep-agent

Clean up build artifacts

hatch clean # clean dist folder
rm -r tmp # clean agent build cache

Contributing

Thinking of contributing to our package? Awesome! 🚀

Please follow our Contributing guide in our documentation and follow our Code of Conduct.

Also, we would be very happy to send you Stroopwafles. Have look at everyone we send a package to so far on our Stroopwafles page.

Support

Contact us and speak directly with the engineers working on AppSignal. They will help you get set up, tweak your code and make sure you get the most out of using AppSignal.

Also see our SUPPORT.md file.