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

The Python agent for Apache SkyWalking
https://github.com/apache/skywalking-python

apm dapper distributed-tracing observability python skywalking

Last synced: 4 days ago
JSON representation

The Python agent for Apache SkyWalking

• Host: GitHub
• URL: https://github.com/apache/skywalking-python
• Owner: apache
• License: apache-2.0
• Created: 2020-05-05T12:13:49.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2024-12-26T04:49:12.000Z (27 days ago)
• Last Synced: 2025-01-10T16:09:06.479Z (12 days ago)
• Topics: apm, dapper, distributed-tracing, observability, python, skywalking
• Language: Python
• Homepage: https://skywalking.apache.org/
• Size: 1.48 MB
• Stars: 194
• Watchers: 36
• Forks: 105
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SkyWalking Python Agent



**SkyWalking-Python**: The Python Agent for Apache SkyWalking provides the native tracing/metrics/logging/profiling abilities for Python projects.

**[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/apache/skywalking-python.svg?style=for-the-badge&label=Stars&logo=github)](https://github.com/apache/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/apache-skywalking)

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

![Build](https://github.com/apache/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.8+.

> 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: **[email protected]**. Mail to `[email protected]`, follow the reply to subscribe the mail list.

* Send `Request to join SkyWalking slack` mail to the mail list(`[email protected]`), we will invite you in.

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

* For Chinese speaker, send `[CN] Request to join SkyWalking slack` mail to the mail list(`[email protected]`), we will invite you in.

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

## License

Apache 2.0