Porting sqlalchemy instrumentation from contrib repo by codeboten · Pull Request #591 · open-telemetry/opentelemetry-python

codeboten · 2020-04-16T19:49:21Z

Porting the existing sqlalchemy instrumentation from the contrib repo to using the OpenTelemetry API and the OpenTelemetry Auto-instrumentation Patcher interface.

This is replacing open-telemetry/opentelemetry-python-contrib#22

mauriciovasquezbernal

I did a first pass and it looks great. I compared to the DataDog implementation and I think the porting you did is just right.
Most of the comments are just nits, maybe we only important one is about updating the assert states to self.assert*...

I tested it with the autoinstrumentation command by running and example and it works without issues.

Should we add an entry in the documentation for it?

...elemetry-instrumentation-sqlalchemy/src/opentelemetry/instrumentation/sqlalchemy/__init__.py

...ntelemetry-instrumentation-sqlalchemy/src/opentelemetry/instrumentation/sqlalchemy/engine.py

mauriciovasquezbernal · 2020-04-17T20:49:22Z

ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/__init__.py

@@ -0,0 +1,13 @@
+# Copyright The OpenTelemetry Authors


Nit: this file could just be empty.

ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/mixins.py

ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_patch.py

Co-Authored-By: Mauricio Vásquez <mauricio@kinvolk.io>

mauriciovasquezbernal · 2020-04-20T20:24:15Z

Is Manifest.in also missing? Example: https://github.com/open-telemetry/opentelemetry-python/blob/master/ext/opentelemetry-ext-dbapi/MANIFEST.in.

mauriciovasquezbernal

LGTM:

I clearly can see how it is based on DataDog donation
Documentation is present
Unit tests are present
Integration tests are implemented and working

ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_mysql.py

ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_postgres.py

Co-Authored-By: Mauricio Vásquez <mauricio@kinvolk.io>

ext/opentelemetry-instrumentation-sqlalchemy/setup.cfg

ext/opentelemetry-ext-sqlalchemy/tests/test_sqlalchemy.py

lzchen · 2020-04-28T02:57:02Z

ext/opentelemetry-ext-sqlalchemy/README.rst

+.. |pypi| image:: https://badge.fury.io/py/opentelemetry-ext-sqlalchemy.svg
+   :target: https://pypi.org/project/opentelemetry-ext-sqlalchemy/
+
+This library allows tracing requests made by the SQLAlchemy library.


Maybe it might be good to call out popular databases that we don't have integrations for that are supported by SQLAlchemy? Or include a link? I get some customers that are confused on which integrations to use for their databases, and we should have a consistent recommendation. I believe we should recommend the specific integrations if they exist (like for mysql), and to try to use SQLAlchemy otherwise (if supported).

I added a link to sqlalchemy to the reference section. Regarding recommendations, I wonder where the best place to put something like this is, seems like it could be part of the examples section 🤔

Maybe we can just verbally indicate in the README: "For MYSQL use the integration(link), for postgres use the integration(link). For all other databases that support SQLAlchemy, use this..."

ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py

ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/engine.py

lzchen · 2020-04-28T17:04:35Z

ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py

+    import sqlalchemy
+
+    trace.set_tracer_provider(TracerProvider())
+    engine = create_engine("sqlite:///:memory:")


I think you need to import create_engine

Fixed! thanks

lzchen

LGTM! Few non-blocking comments.

ocelotl

LGTM, probably just needs minor lint fixes to pass those tests again.

Alex Boten added 11 commits April 16, 2020 12:48

initial commit of sqlalchemy instrumentation

2b89356

adding instrumentation code and test

1ce3640

adding integration tests

dab0d5e

cleaning up

b79a08a

use psycopg2 parse_dsn method

a9d70ad

more cleanup

295f0f6

adding license headers

e0be528

apply semantic conventions

6023635

adding error to status description

b7465cc

cleaning up tests

7de0d10

cleaning up comments

378054f

codeboten marked this pull request as ready for review April 17, 2020 15:16

codeboten requested a review from a team April 17, 2020 15:16

Merge branch 'master' into add-sqlalchemy

7e7b24a

codeboten mentioned this pull request Apr 17, 2020

Instrumenting sqlalchemy open-telemetry/opentelemetry-python-contrib#22

Closed

isort fixes

38d4450

codeboten added the instrumentation Related to the instrumentation of third party libraries or frameworks label Apr 17, 2020

mauriciovasquezbernal reviewed Apr 17, 2020

View reviewed changes

alrex and others added 4 commits April 17, 2020 16:25

Apply suggestions from code review

7ef2cdf

Co-Authored-By: Mauricio Vásquez <mauricio@kinvolk.io>

use TestBase

ffe2c90

fix missing dep and lint

d91b73d

fix lint

76a6141

codeboten added the needs reviewers PRs with this label are ready for review and needs people to review to move forward. label Apr 20, 2020

Alex Boten added 3 commits April 20, 2020 15:46

cleaning up docs, adding manifest, receive tracer_provider

8f94ce3

Merge remote-tracking branch 'origin/master' into add-sqlalchemy

24cf7ea

removing reload

8362198

mauriciovasquezbernal approved these changes Apr 21, 2020

View reviewed changes

ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_mysql.py Outdated Show resolved Hide resolved

ext/opentelemetry-ext-docker-tests/tests/sqlalchemy_tests/test_postgres.py Outdated Show resolved Hide resolved

Apply suggestions from code review

7accae8

Co-Authored-By: Mauricio Vásquez <mauricio@kinvolk.io>

mauriciovasquezbernal reviewed Apr 22, 2020

View reviewed changes

ext/opentelemetry-instrumentation-sqlalchemy/setup.cfg Outdated Show resolved Hide resolved

Alex Boten added 9 commits April 24, 2020 15:28

Merge remote-tracking branch 'origin/master' into add-sqlalchemy

fc39a59

rename from instrumentation to ext

6a9f708

finish renaming

9f37c48

move patch code into Instrumentor

633b7a9

minor fixes

91a71f2

Merge remote-tracking branch 'origin/master' into add-sqlalchemy

5d03e46

lint fixes

90bb1ec

simplifying tests

256a52d

Merge branch 'master' into add-sqlalchemy

47ae2fb

ocelotl suggested changes Apr 27, 2020

View reviewed changes

ext/opentelemetry-ext-sqlalchemy/tests/test_sqlalchemy.py Outdated Show resolved Hide resolved

ext/opentelemetry-ext-sqlalchemy/tests/test_sqlalchemy.py Outdated Show resolved Hide resolved

mauriciovasquezbernal reviewed Apr 27, 2020

View reviewed changes

ext/opentelemetry-ext-sqlalchemy/tests/test_sqlalchemy.py Outdated Show resolved Hide resolved

lzchen reviewed Apr 28, 2020

View reviewed changes

ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py Outdated Show resolved Hide resolved

lzchen reviewed Apr 28, 2020

View reviewed changes

ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/engine.py Outdated Show resolved Hide resolved

Alex Boten added 7 commits April 27, 2020 21:15

cleaning up tests, removing mock

fced29b

removing trace_engine, cleaning up docstrings

a03b0c4

add link to sqlalchemy

963c482

setattr is no longer needed

1b0163a

updating example, adding test for auto-instrumentation

184cf45

Merge remote-tracking branch 'origin/master' into add-sqlalchemy

bb74381

cleaning unnecessary check

1c731b8

codeboten requested review from lzchen and ocelotl April 28, 2020 15:44

lzchen reviewed Apr 28, 2020

View reviewed changes

lzchen approved these changes Apr 28, 2020

View reviewed changes

fix example

e66172f

ocelotl approved these changes Apr 28, 2020

View reviewed changes

Merge branch 'master' into add-sqlalchemy

123e2c5

c24t approved these changes Apr 29, 2020

View reviewed changes

c24t merged commit e6a9d97 into open-telemetry:master Apr 29, 2020

Conversation

codeboten commented Apr 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

mauriciovasquezbernal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mauriciovasquezbernal Apr 17, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mauriciovasquezbernal commented Apr 20, 2020

Uh oh!

mauriciovasquezbernal left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lzchen Apr 28, 2020

Choose a reason for hiding this comment

Uh oh!

codeboten Apr 28, 2020

Choose a reason for hiding this comment

Uh oh!

lzchen Apr 28, 2020

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

lzchen Apr 28, 2020

Choose a reason for hiding this comment

Uh oh!

codeboten Apr 28, 2020

Choose a reason for hiding this comment

Uh oh!

lzchen left a comment

Choose a reason for hiding this comment

Uh oh!

ocelotl left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

codeboten commented Apr 16, 2020 •

edited

Loading