opentelemetry-python-contrib

OpenTelemetry instrumentation for Python modules

Go to file

Tom de Bruijn 673e4aadb4 Record exception in Celery instrumentation (#1573 ) * Add tests for errors in Celery tasks I noticed there were no tests for the error scenario in the Celery package. This commit adds a basic test, based on the previous test and how I see other packages test the error status on the span. Part of #987 * Record exception in Celery instrumentation In addition to setting the status on the span, also record the exception on the span. This adds an event to the span with more details about the error, following the format other instrumentations also use. * Update CHANGELOG with Celery record exception * Fix lint code formatting issues * Move Celery error tests to the functional tests The celery tests failed on Python 3.11. This is most likely due to this issue in billiard, a celery dependency, about it not working on Python 3.11 because of the error reported in the CI: https://github.com/celery/billiard/issues/377 It's been fixed in billiard 4.1.0, but celery is locked on billiard version lower than 4, so it cannot use this version with the fix. This issue does not arise on the Docker tests, because they use Python 3.9.16. I've moved the error test span event assertions to the error test that is available in the functional tests, and removed the unit test. That way, the build will run successfully. * Remove duplicate entry in changelog This was added in a recent merge commit on this PR branch. * Remove unused test code With the move of the tests for tasks with errors to the functional tests, remove the unit test's error task and unused imports. --------- Co-authored-by: Srikanth Chekuri <srikanth.chekuri92@gmail.com>		2023-02-03 04:30:57 +00:00
.github	Fix install of Python 3.10 on GitHub Actions (#1609 )	2023-02-03 08:37:24 +05:30
_template	Update version to 1.16.0.dev/0.37b0.dev (#1485 )	2022-12-10 04:03:22 +05:30
docs	add python-kafka to docs (#1552 )	2023-01-07 05:19:39 +00:00
exporter	Fix install of Python 3.10 on GitHub Actions (#1609 )	2023-02-03 08:37:24 +05:30
instrumentation	Record exception in Celery instrumentation (#1573 )	2023-02-03 04:30:57 +00:00
opentelemetry-contrib-instrumentations	Update version to 1.16.0.dev/0.37b0.dev (#1485 )	2022-12-10 04:03:22 +05:30
opentelemetry-distro	[docs] fix broken link (#1513 )	2022-12-22 22:30:21 +05:30
opentelemetry-instrumentation	Fix install of Python 3.10 on GitHub Actions (#1609 )	2023-02-03 08:37:24 +05:30
propagator	Fix install of Python 3.10 on GitHub Actions (#1609 )	2023-02-03 08:37:24 +05:30
scripts	Automated release workflow (#1580 )	2023-01-19 01:47:34 +05:30
sdk-extension/opentelemetry-sdk-extension-aws	Implement aws.ecs.* resource attributes (#1212 )	2023-01-11 21:35:02 +00:00
tests/opentelemetry-docker-tests/tests	Record exception in Celery instrumentation (#1573 )	2023-02-03 04:30:57 +00:00
util/opentelemetry-util-http	Update version to 1.16.0.dev/0.37b0.dev (#1485 )	2022-12-10 04:03:22 +05:30
.codespellrc	Codespell ci (#1237 )	2022-08-29 15:08:25 +05:30
.coveragerc	Update tooling (#1330 )	2022-09-15 23:42:49 +05:30
.flake8	Refactor comments in .flake8 (#1470 )	2022-11-29 14:04:48 +01:00
.gitignore	remove need to clone core repo (#678 )	2021-09-27 20:28:32 +00:00
.isort.cfg	remove need to clone core repo (#678 )	2021-09-27 20:28:32 +00:00
.pylintrc	Remove DataDog exporter from main (#1366 )	2022-10-06 10:46:31 +00:00
.readthedocs.yml	update python version for readthedocs (#297 )	2021-01-26 09:51:37 -08:00
CHANGELOG.md	Record exception in Celery instrumentation (#1573 )	2023-02-03 04:30:57 +00:00
CONTRIBUTING.md	Pin tox version (#1480 )	2022-12-08 16:39:48 -06:00
LICENSE	Fix error in license files (#521 )	2021-05-28 09:16:58 -07:00
LICENSE.Apache	Small cleanup (#27 )	2020-04-08 13:17:31 -07:00
LICENSE.BSD3	Small cleanup (#27 )	2020-04-08 13:17:31 -07:00
README.md	Update README.md (#1617 )	2023-02-03 03:46:25 +00:00
RELEASING.md	Automated release workflow (#1580 )	2023-01-19 01:47:34 +05:30
dev-requirements.txt	Automated release workflow (#1580 )	2023-01-19 01:47:34 +05:30
docs-requirements.txt	add python-kafka to docs (#1552 )	2023-01-07 05:19:39 +00:00
eachdist.ini	Update version to 1.16.0.dev/0.37b0.dev (#1485 )	2022-12-10 04:03:22 +05:30
gen-requirements.txt	Update tooling (#1330 )	2022-09-15 23:42:49 +05:30
pyproject.toml	Upgrade black (#802 )	2021-11-10 20:57:01 +00:00
pytest.ini	Falcon 3 support (#644 )	2021-09-27 19:58:13 +00:00
tox.ini	Fix install of Python 3.10 on GitHub Actions (#1609 )	2023-02-03 08:37:24 +05:30

README.md

Getting Started • API Documentation • Getting In Touch (GitHub Discussions)

Contributing • Examples

OpenTelemetry Python Contrib

The Python auto-instrumentation libraries for OpenTelemetry (per OTEP 0001)

Installation

This repository includes installable packages for each instrumented library. Libraries that produce telemetry data should only depend on opentelemetry-api, and defer the choice of the SDK to the application developer. Applications may depend on opentelemetry-sdk or another package that implements the API.

Please note that these libraries are currently in beta, and shouldn't generally be used in production environments.

The instrumentation/ directory includes OpenTelemetry instrumentation packages, which can be installed separately as:

pip install opentelemetry-instrumentation-{integration}

To install the development versions of these packages instead, clone or fork this repo and do an editable install:

pip install -e ./instrumentation/opentelemetry-instrumentation-{integration}

Releasing

Maintainers release new versions of the packages in opentelemetry-python-contrib on a monthly cadence. See releases for all previous releases.

Contributions that enhance OTel for Python are welcome to be hosted upstream for the benefit of group collaboration. Maintainers will look for things like good documentation, good unit tests, and in general their own confidence when deciding to release a package with the stability guarantees that are implied with a 1.0 release.

To resolve this, members of the community are encouraged to commit to becoming a CODEOWNER for packages in -contrib that they feel experienced enough to maintain. CODEOWNERS can then follow the checklist below to release -contrib packages as 1.0 stable:

Releasing a package as `1.0` stable

To release a package as 1.0 stable, the package:

SHOULD have a CODEOWNER. To become one, submit an issue and explain why you meet the responsibilities found in CODEOWNERS.
MUST have unit tests that cover all supported versions of the instrumented library.
- e.g. Instrumentation packages might use different techniques to instrument different major versions of python packages
MUST have clear documentation for non-obvious usages of the package
- e.g. If an instrumentation package uses flags, a token as context, or parameters that are not typical of the BaseInstrumentor class, these are documented
After the release of 1.0, a CODEOWNER may no longer feel like they have the bandwidth to meet the responsibilities of maintaining the package. That's not a problem at all, life happens! However, if that is the case, we ask that the CODEOWNER please raise an issue indicating that they would like to be removed as a CODEOWNER so that they don't get pinged on future PRs. Ultimately, we hope to use that issue to find a new CODEOWNER.

Contributing

See CONTRIBUTING.md

We meet weekly on Thursday, and the time of the meeting alternates between 9AM PT and 4PM PT. The meeting is subject to change depending on contributors' availability. Check the OpenTelemetry community calendar for specific dates and for the Zoom link.

Meeting notes are available as a public Google doc. For edit access, get in touch on GitHub Discussions.

Approvers (@open-telemetry/python-approvers):

Aaron Abbott, Google
Sanket Mehta, Cisco
Shalev Roda, Cisco

Emeritus Approvers:

Find more about the approver role in community repository.

Maintainers (@open-telemetry/python-maintainers):

Diego Hurtado, Lightstep
Leighton Chen, Microsoft
Srikanth Chekuri, signoz.io

Emeritus Maintainers:

Alex Boten, Lightstep
Owais Lone, Splunk

Find more about the maintainer role in community repository.

Running Tests Locally

Go to your Contrib repo directory. cd ~/git/opentelemetry-python-contrib.
Create a virtual env in your Contrib repo directory. python3 -m venv my_test_venv.
Activate your virtual env. source my_test_venv/bin/activate.
Make sure you have tox installed. pip install tox==3.27.1.
Run tests for a package. (e.g. tox -e test-instrumentation-flask.)