https://github.com/sparticleinc/skywalking-python

https://github.com/sparticleinc/skywalking-python

Last synced: 6 days ago
JSON representation

• Host: GitHub
• URL: https://github.com/sparticleinc/skywalking-python
• Owner: sparticleinc
• License: apache-2.0
• Created: 2023-09-20T08:26:15.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2026-04-14T14:42:08.000Z (2 months ago)
• Last Synced: 2026-05-09T05:13:46.965Z (about 1 month ago)
• Language: Python
• Size: 751 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Notice: NOTICE

Awesome Lists containing this project

README

          
# SkyWalking Python Agent



**`sparticle-skywalking`** is the Sparticle-maintained PyPI distribution of the SkyWalking Python agent.

It provides the native tracing/metrics/logging/profiling abilities for Python projects while keeping the runtime import path unchanged as `skywalking`.

**[SkyWalking](https://github.com/apache/skywalking)**: Application performance monitor tool for distributed systems, especially designed for microservices, cloud native and container-based (Kubernetes) architectures.

[![GitHub stars](https://img.shields.io/github/stars/sparticleinc/skywalking-python.svg?style=for-the-badge&label=Stars&logo=github)](https://github.com/sparticleinc/skywalking-python)

[![Twitter Follow](https://img.shields.io/twitter/follow/asfskywalking.svg?style=for-the-badge&label=Follow&logo=twitter)](https://twitter.com/AsfSkyWalking)

![Release](https://img.shields.io/pypi/v/sparticle-skywalking)

![Version](https://img.shields.io/pypi/pyversions/sparticle-skywalking)

![Build](https://github.com/sparticleinc/skywalking-python/actions/workflows/CI.yaml/badge.svg?event=push)

## Documentation

- [Official documentation](https://skywalking.apache.org/docs/#PythonAgent)

- [Blog](https://skywalking.apache.org/blog/2021-09-12-skywalking-python-profiling/) about the Python Agent Profiling Feature

## Capabilities

| Reporter  | Supported?      | Details                                                    |

| :-------- | :-------------- | :--------------------------------------------------------- |

| Trace     | ✅ (default: ON) | Automatic instrumentation + Manual SDK                     |

| Log       | ✅ (default: ON) | Direct reporter only. (Tracing context in log planned)     |

| Meter     | ✅ (default: ON) | Meter API + Automatic PVM metrics                          |

| Event     | ❌ (Planned)     | Report lifecycle events of your awesome Python application |

| Profiling | ✅ (default: ON) | Threading and Greenlet Profiler                            |

## Installation Requirements

SkyWalking Python Agent requires [Apache SkyWalking 8.0+](https://skywalking.apache.org/downloads/#SkyWalkingAPM) and Python 3.10+.

```bash

pip install "sparticle-skywalking"

pip install "sparticle-skywalking[all]"

```

> If you would like to try out the latest features that are not released yet, please refer to this [guide](docs/en/setup/faq/How-to-build-from-sources.md) to build from sources.

## Live Demo

- Find the [live demo](https://skywalking.apache.org/#demo) with Python agent on our website.

- Follow the [showcase](https://skywalking.apache.org/docs/skywalking-showcase/next/readme/) to set up preview deployment quickly.

## Contributing

Before submitting a pull request or pushing a commit, please read our [contributing](CONTRIBUTING.md) and [developer guide](docs/en/contribution/Developer.md).

## Contact Us

* Mail list: **dev@skywalking.apache.org**. Mail to `dev-subscribe@skywalking.apache.org`, follow the reply to subscribe the mail list.

* Send `Request to join SkyWalking slack` mail to the mail list(`dev@skywalking.apache.org`), we will invite you in.

* Twitter, [ASFSkyWalking](https://twitter.com/AsfSkyWalking)

* QQ Group: 901167865, 392443393

* Package maintenance contact: hy.zhu@sparticle.com

* [bilibili B站 视频](https://space.bilibili.com/390683219)

## License

Apache 2.0