Skip to content

Commit 8567673

Browse files
authored
README: Advise about (not) using older pip.
1 parent 79a61c3 commit 8567673

File tree

1 file changed

+27
-1
lines changed

1 file changed

+27
-1
lines changed

README.md

Lines changed: 27 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@ This SDK enables Dynatrace customers to extend request level visibility into Pyt
2020
* [SQL database requests](#sql-database-requests)
2121
* [Incoming web requests](#incoming-web-requests)
2222
- [Troubleshooting](#troubleshooting)
23+
* [Installation issues](#installation-issues)
24+
* [Post-installation issues](#post-installation-issues)
2325
- [Repository contents](#repository-contents)
2426
- [Help & Support](#help--support)
2527
* [Read the manual](#read-the-manual)
@@ -34,12 +36,14 @@ This SDK enables Dynatrace customers to extend request level visibility into Pyt
3436

3537
The SDK supports Python 2 ≥ 2.7 and Python 3 ≥ 3.4. Only the official CPython (that is, the "normal" Python, i.e. the Python implementation
3638
from <https://python.org>) is supported and only on Linux (musl libc is currently not supported) and Windows with the x86 (including
37-
x86-64) architecture.
39+
x86-64) architecture. Additionally, `pip` ≥ 8.1.0 (2016-03-05) is required for installation.
3840

3941
The Dynatrace OneAgent SDK for Python is a wrapper of the [Dynatrace OneAgent SDK for C/C++](https://github.com/Dynatrace/OneAgent-SDK-for-C) and therefore the SDK for C/C++ is required and delivered with the Python SDK. See [here](https://github.com/Dynatrace/OneAgent-SDK-for-C#dynatrace-oneagent-sdk-for-cc-requirements) for its requirements, which also apply to the SDK for Python.
4042

4143
The version of the SDK for C/C++ that is included in each version of the SDK for Python is shown in the following table along with the required Dynatrace OneAgent version (it is the same as [listed in the OneAgent SDK for C/C++'s documentation](https://github.com/Dynatrace/OneAgent-SDK-for-C/blob/master/README.md#compatibility-of-dynatrace-oneagent-sdk-for-cc-releases-with-oneagent-releases)).
4244

45+
<a name="pycversiontab"></a>
46+
4347
|OneAgent SDK for Python|OneAgent SDK for C/C++|Dynatrace OneAgent|
4448
|:----------------------|:---------------------|:-----------------|
4549
|1.0 |1.1.0 |≥1.141 |
@@ -287,6 +291,27 @@ There is currently no explicit support for tracing outgoing web requests. You ca
287291
<a name="troubleshooting"></a>
288292
## Troubleshooting
289293

294+
### Installation issues
295+
296+
* `ValueError` when installing, complaining about missing `DT_PYSDK_CSDK_PATH`.
297+
298+
Make sure you are using pip to install a prebuilt package wheel for your system from PyPI, as described in [Using the OneAgent SDK for
299+
Python in your application](#installation). Also make sure you are using an up-to date version of `pip`, `setuptools` and `wheel`. You can
300+
try upgrading them with `python -m pip install --upgrade pip setuptools wheel` (make sure to use the same `python` that you use to install
301+
the `oneagent-sdk` package). ATTENTION: If you use the system-provided pip (e.g. installed via `apt-get` on Ubuntu) you should instead use
302+
a `pip` inside a `virtualenv` (the same as your project), as uprading system-provided packages via `pip` may cause issues.
303+
304+
If this does not resolve the issue, make sure you are using a supported platform, as listed in [Requirements](#requirements). If you *are*
305+
using a supported system, you can try downloading the [OneAgent SDK for C/C++](https://github.com/Dynatrace/OneAgent-SDK-for-C) in the
306+
version corresponding to your OneAgent SDK for Python as listed in [the table in Requirements](#requirements). Then set the
307+
`DT_PYSDK_CSDK_PATH` environment variable to the `.so`/`.dll` file corresponding to your platform in the `lib` subdirectory of the C SDK
308+
and retry the installation (e.g. in a bash shell, use `export DT_PYSDK_CSDK_PATH=path/to/onesdk_shared.so`). If there is no corresponding
309+
directory, your platfom is not supported. Otherwise, regardless if it works with that method or not, please report an issue as desribed in
310+
[Let us help you](#let-us-help-you).
311+
312+
313+
### Post-installation issues
314+
290315
To debug your OneAgent SDK for Python installation, execute the following Python code:
291316

292317
```python
@@ -304,6 +329,7 @@ Known gotchas:
304329

305330
Make sure that the `pip install` or equivalent succeeded (see [here](#installation)). Also make sure you use the `pip` corresponding to your `python` (if in doubt, use `python -m pip` instead of `pip` for installing).
306331

332+
307333
<a name="repository-contents"></a>
308334
## Repository contents
309335

0 commit comments

Comments
 (0)