Python solarwinds-apm
An OpenTelemetry Python distribution for SolarWinds Observability. Provides automatic configuration, instrumentation, and APM data export for Python applications.
Requirements
All published artifacts support Python 3.10 or higher. A full list of system requirements is available at SolarWinds Observability System Requirements.
See 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 "psutil>=5.0"
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 "psutil>=5.0"
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=<set-service-key-here>
export SW_APM_COLLECTOR=<set-collector-here>
Run your application with the prefix opentelemetry-instrument to wrap all common Python frameworks and start exporting OpenTelemetry traces and metrics:
opentelemetry-instrument <command_to_run_your_service>
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.
Online documentation for SolarWinds APM Python features, configuration, and more is available at SolarWinds Observability.
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. Thank you to everyone who has contributed:
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file solarwinds_apm-7.2.0.tar.gz.
File metadata
- Download URL: solarwinds_apm-7.2.0.tar.gz
- Upload date:
- Size: 72.5 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
8d72a5d5b02595444464fb3e56fbac43982a8e1e6d19caf87fb1109f280de6c6
|
|
| MD5 |
08f889b02c75aefdcf9fd6a59690f8ce
|
|
| BLAKE2b-256 |
2d0711de32efd42e536e156658b6d08369dd9db7f305b02303fde604ade33a3a
|
Provenance
The following attestation bundles were made for solarwinds_apm-7.2.0.tar.gz:
Publisher:
build_publish_pypi_and_draft_release.yaml on solarwinds/apm-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
solarwinds_apm-7.2.0.tar.gz -
Subject digest:
8d72a5d5b02595444464fb3e56fbac43982a8e1e6d19caf87fb1109f280de6c6 - Sigstore transparency entry: 2666396629
- Sigstore integration time:
-
Permalink:
solarwinds/apm-python@c902089473f6d5ffe5c3dc4701b930ca1e04015d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/solarwinds
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build_publish_pypi_and_draft_release.yaml@c902089473f6d5ffe5c3dc4701b930ca1e04015d -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file solarwinds_apm-7.2.0-py3-none-any.whl.
File metadata
- Download URL: solarwinds_apm-7.2.0-py3-none-any.whl
- Upload date:
- Size: 81.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6a72f931161c3da8ff6d8cdf28b053da008269396bda8d6cdce6185c2a03d7a5
|
|
| MD5 |
50e41c6315959361f47a637286ce252b
|
|
| BLAKE2b-256 |
a4c74f952e2b243e57246ee328394e36061496d27da3892c35da1f16ff33e94c
|
Provenance
The following attestation bundles were made for solarwinds_apm-7.2.0-py3-none-any.whl:
Publisher:
build_publish_pypi_and_draft_release.yaml on solarwinds/apm-python
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
solarwinds_apm-7.2.0-py3-none-any.whl -
Subject digest:
6a72f931161c3da8ff6d8cdf28b053da008269396bda8d6cdce6185c2a03d7a5 - Sigstore transparency entry: 2666396648
- Sigstore integration time:
-
Permalink:
solarwinds/apm-python@c902089473f6d5ffe5c3dc4701b930ca1e04015d -
Branch / Tag:
refs/heads/main - Owner: https://github.com/solarwinds
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
build_publish_pypi_and_draft_release.yaml@c902089473f6d5ffe5c3dc4701b930ca1e04015d -
Trigger Event:
workflow_dispatch
-
Statement type:
