Sidekick Python Agent
Table of Contents
Sidekick is a live application debugger that lets you troubleshoot your applications while they keep on running.
Add dynamic logs and put non-breaking breakpoints in your running application without the need of stopping & redeploying.
Sidekick Open Source is here to allow self-hosting and make live debugging more accessible. Built for everyone who needs extra information from their running applications.
Sidekick has two major actions; Tracepoints & Logpoints.
- A tracepoint is a non-breaking remote breakpoint. In short, it takes a snapshot of the variables when the code hits that line.
- Logpoints open the way for dynamic(on-demand) logging to Sidekick users. Replacing traditional logging with dynamic logging has the potential to lower stage sizes, costs, and time for log searching while adding the ability to add new logpoints without editing the source code, redeploying, or restarting the application.
Supported runtimes: Java, Python, Node.js
To learn more about Sidekick features and capabilities, see our web page.
Sidekick Python agent allows you to inject tracepoints (non-breaking breakpoints) and logpoints dynamically to capture call stack snapshots (with variables) and add log messages on the fly without code modification, re-build and re-deploy. So it helps you, your team, and your organization to reduce MTTR (Minimum Time to Repair/Resolve).
To achieve this, Sidekick Python Agent makes use of Google Python Cloud Debugger Agent's breakpoint implementations under the hood.
The advantage of Sidekick over classical APM solutions is that, Sidekick
- can debug and trace any location (your code base or 3rd party dependency) in your application, not just the external (DB, API, etc ...) calls like APM solutions
- has zero overhead when you don't have any tracepoint or logpoint but APMs have always
- doesn't produce too much garbage data because it collects data only at the certain points you specified as long as that point (tracepoint/logpoint) is active
Follow the below steps to install Sidekick Agent Python to your application.
- Install the latest Sidekick agent:
pip install sidekick-agent-python
Configure the agent via exporting environment variables or creating .env file and load it in source code.
ARM64 & M1 support: Currently ARM64 packages are not published to PyPI directory. They will be published soon and you can build the agent yourself to make use of it on an ARM machine.
- pipenv
Activate pipenv with the following command and install dependencies mentioned in Pipfile.
pipenv shell
pipenv install
Build tracepointdebug.
Check if "setup.cfg" file is created or not
./build.sh
Check if build directory is created or not. If it is not created, run the following command to generate the source and the distribution binary.
./build_tools/build_wheels.sh
To debug Sidekick Python Agent, add "build/lib.*/tracepointdebug" by creating a soft link in the application directory and configure your app according to Sidekick docs. Make sure your project's Python version is the same with Sidekick Python Agent's version.
To report a bug or request a feature, create a GitHub Issue. Please ensure someone else has not created an issue for the same topic.
Reach out on the Discord. A fellow community member or Sidekick engineer will be happy to help you out.