Skip to content

Commit 773e431

Browse files
srikanthccvshalevr
andauthored
Add a note about system dependencies for instrumentation pkgs (#2068)
Co-authored-by: Shalev Roda <[email protected]>
1 parent 5888d4e commit 773e431

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

Diff for: CONTRIBUTING.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -52,9 +52,13 @@ An easier way to do so is:
5252
2. Run `.tox/lint/bin/isort .`
5353

5454
See
55-
[`tox.ini`](https://github.com/open-telemetry/opentelemetry-python/blob/main/tox.ini)
55+
[`tox.ini`](https://github.com/open-telemetry/opentelemetry-python-contrib/blob/main/tox.ini)
5656
for more detail on available tox commands.
5757

58+
### Troubleshooting
59+
60+
- Some packages may require additional system wide dependencies to be installed. For example, you may need to install `libpq-dev` to run the postgresql client libraries instrumentation tests. or `libsnappy-dev` to run the prometheus exporter tests. If you encounter a build error, please check the installation instructions for the package you are trying to run tests for.
61+
5862
### Benchmarks
5963

6064
Performance progression of benchmarks for packages distributed by OpenTelemetry Python can be viewed as a [graph of throughput vs commit history](https://opentelemetry-python-contrib.readthedocs.io/en/latest/performance/benchmarks.html). From the linked page, you can download a JSON file with the performance results.

0 commit comments

Comments
 (0)