OpenTelemetry instrumentation for Python modules
Go to file
Leighton Chen 4d67d7fec2 chore: bump dev version (#1235) 2020-10-21 22:04:59 -07:00
.github adding pull request template 2020-10-01 22:26:10 -07:00
_template removing references to python 3.4 2020-10-01 22:22:49 -07:00
instrumentation chore: bump dev version (#1235) 2020-10-21 22:04:59 -07:00
reference Removing reference to ported instrumentation (#44) 2020-09-15 08:28:27 -07:00
scripts Add eachdist and move tox to root folder (#29) 2020-04-09 10:06:59 -07:00
.coveragerc Add eachdist and move tox to root folder (#29) 2020-04-09 10:06:59 -07:00
.flake8 Add eachdist and move tox to root folder (#29) 2020-04-09 10:06:59 -07:00
.gitignore Small cleanup (#27) 2020-04-08 13:17:31 -07:00
.isort.cfg Add eachdist and move tox to root folder (#29) 2020-04-09 10:06:59 -07:00
.pylintrc Remove non-inclusive language (#43) 2020-09-08 17:06:47 -07:00
CODEOWNERS initial commit 2019-11-15 08:52:03 -08:00
LICENSE initial commit 2019-11-15 08:52:03 -08: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 adding instructions to port instrumentation (#26) 2020-04-09 11:16:33 -07:00
dev-requirements.txt Add eachdist and move tox to root folder (#29) 2020-04-09 10:06:59 -07:00
eachdist.ini ignore _template (#31) 2020-04-09 13:16:14 -07:00
pyproject.toml Add eachdist and move tox to root folder (#29) 2020-04-09 10:06:59 -07:00
pytest.ini Add eachdist and move tox to root folder (#29) 2020-04-09 10:06:59 -07:00
tox.ini removing travis 2020-10-01 22:24:30 -07:00

README.md

opentelemetry-auto-instr-python

The auto-instrumentation for Python (per OTEP 0001) instruments each library in a separately installable package to ensure users only need to install the libraries that make sense for their use-case. This repository contains the code initially donated by DataDog in the reference folder. All instrumentation that has been ported lives in the instrumentation directory.

porting ddtrace/contrib to instrumentation

The steps below describe the process to port integrations from the reference directory containing the originally donated code to OpenTelemetry.

  1. Move the code into the instrumentation directory
mkdir -p instrumentation/opentelemetry-instrumentation-jinja2/src/opentelemetry/instrumentation/jinja2
git mv reference/ddtrace/contrib/jinja2 instrumentation/opentelemetry-instrumentation-jinja2/src/opentelemetry/instrumentation/jinja2
  1. Move the tests
git mv reference/tests/contrib/jinja2 instrumentation/opentelemetry-instrumentation-jinja2/tests
  1. Add README.rst, setup.cfg and setup.py files and update them accordingly
cp _template/* instrumentation/opentelemetry-instrumentation-jinja2/
  1. Add version.py file and update it accordingly
mv instrumentation/opentelemetry-instrumentation-jinja2/version.py instrumentation/opentelemetry-instrumentation-jinja2/src/opentelemetry/instrumentation/jinja2/version.py
  1. Fix relative import paths to using ddtrace package instead of using relative paths
  2. Update the code and tests to use the OpenTelemetry API