Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/solarwinds/apm-python
OpenTelemetry-based SolarWinds APM Python library
https://github.com/solarwinds/apm-python
Last synced: about 1 month ago
JSON representation
OpenTelemetry-based SolarWinds APM Python library
- Host: GitHub
- URL: https://github.com/solarwinds/apm-python
- Owner: solarwinds
- License: apache-2.0
- Created: 2021-09-04T01:09:12.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-09-26T23:19:36.000Z (about 2 months ago)
- Last Synced: 2024-09-27T07:02:31.315Z (about 2 months ago)
- Language: Python
- Homepage:
- Size: 2.51 MB
- Stars: 5
- Watchers: 3
- Forks: 1
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Codeowners: CODEOWNERS
- Security: SECURITY.md
Awesome Lists containing this project
README
[](https://badge.fury.io/py/solarwinds-apm)  [](https://github.com/solarwinds/apm-python/blob/main/LICENSE)
# Python solarwinds-apm
An [OpenTelemetry Python](https://opentelemetry-python.readthedocs.io/) distribution for SolarWinds Observability. Provides automatic configuration, instrumentation, and APM data export for Python applications.
----
## Requirements
All published artifacts support Python 3.8 or higher. A full list of system requirements is available at [SolarWinds Observability System Requirements](https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=app-sysreqs-python-agent).
See [CONTRIBUTING.md](https://github.com/solarwinds/apm-python/blob/main/CONTRIBUTING.md) for how to build for development.
## Getting Started
SolarWinds APM captures OpenTelemetry distributed traces and metrics from your application and sends them to SolarWinds Observability for analysis and visualization.
To install `solarwinds-apm` and all relevant Opentelemetry Python instrumentation libraries:
```
pip install solarwinds-apm
opentelemetry-bootstrap --action=install
```
`solarwinds-apm` already includes OpenTelemetry and therefore doesn't need to be installed separately. Python agent installation should be done _after_ installation of all other service dependencies. This is so `opentelemetry-bootstrap` detects those packages and installs their corresponding instrumentation libraries. For example:
```
pip install -r requirements.txt # installs all other dependencies
pip install solarwinds-apm
opentelemetry-bootstrap --action=install
```
Set the service key and ingestion endpoint. An easy way to do this is via environment variables available to your application process. An example:
```
export SW_APM_SERVICE_KEY=
export SW_APM_COLLECTOR=
```
Run your application with the prefix `opentelemetry-instrument` to wrap all common Python frameworks and start exporting OpenTelemetry traces and metrics:
```
opentelemetry-instrument
```
You can also add custom span generation to your code by using the OpenTelemetry SDK. For example:
```
from opentelemetry import trace
tracer = trace.get_tracer(__name__)
with tracer.start_as_current_span("my_custom_span") as custom_span:
custom_span.set_attribute("my_custom_attribute", "foo_value")
print("Here is my custom OpenTelemetry span")
```
## Documentation
OpenTelemetry Python documentation is available at the [OpenTelemetry-Python API Reference](https://opentelemetry-python.readthedocs.io/).
Online documentation for SolarWinds APM Python features, configuration, and more is available at [SolarWinds Observability](https://documentation.solarwinds.com/en/success_center/observability/default.htm#cshid=app-add-python-agent).
## Contributing
OpenTelemetry Python would not be possible without collaborations and efforts from many contributors. Our common goals as a community are to improve end user/developer experiences and empower them.
For more information about contributing to Python `solarwinds-apm`, see [CONTRIBUTING.md](https://github.com/solarwinds/apm-python/blob/main/CONTRIBUTING.md). Thank you to everyone who has contributed:
