Add pymssql instrumentation #394

guillaumep · 2021-04-01T19:03:49Z

Description

This pull request implements instrumentation for the pymssql library (https://pypi.org/project/pymssql/).
It is basically a copy of the pymysql instrumentation.

Still a work-in-progress.

Type of change

New feature (non-breaking change which adds functionality)
This change requires a documentation update

How Has This Been Tested?

Ran tox tests
Tested manually in a python program - verified that traces are properly sent

Does This PR Require a Core Repo Change?

Yes. - Link to PR:
No.

Checklist:

See contributing.md for styleguide, changelog guidelines, and more.

Followed the style guidelines of this project
Changelogs have been updated [PARTIAL] -> I can complete that once the PR is opened and I have an issue number
Unit tests have been added
Documentation has been updated

linux-foundation-easycla · 2021-04-01T19:03:52Z

The committers are authorized under a signed CLA.

✅ guillaumep (0860e38)

guillaumep · 2021-04-01T19:33:04Z

It seems from the CI logs that pymssql does not build for pypy3.

Would it be acceptable to disable pypy3 support in the tests for this instrumentation?

guillaumep · 2021-04-01T19:34:03Z

Also, the docs fails to build because of this error:

sphinx.errors.SphinxWarning: autodoc: failed to import module 'pymssql' from module 'opentelemetry.instrumentation'; the following exception was raised:
No module named 'pymssql'

I'm trying to figure out my error, can someone experienced with the repo help?

guillaumep · 2021-04-07T04:05:41Z

I had to subclass DatabaseApiIntegration to obtain pymssql's connection attributes, as the attributes are not kept by the library in the Connection object. You need to get them from the connect function parameter.

guillaumep · 2021-04-07T14:01:17Z

.../opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py

+    def wrapped_connection(
+        self,
+        connect_method: typing.Callable[..., typing.Any],
+        args: typing.Tuple[typing.Any, typing.Any],


The typing is wrong here, need a variable number of arguments in the tuple.

linux-foundation-easycla · 2021-07-22T17:48:58Z

The committers are authorized under a signed CLA.

✅ guillaumep (b93ad00)

lzchen · 2022-02-02T18:09:30Z

@guillaumep
Are you still working on this?

guillaumep · 2022-02-02T21:43:26Z

@lzchen I was expecting help with the issues I mentioned in the comments above, but since I never got any replies up to now I had put this work aside.

pymssql instrumention is still a feature we want at work (outbox.com), so if I can have proper support regarding my questions I'll be glad to finish this PR.

Let me rebase the PR this week and post back here with the current issues I will have.

lzchen · 2022-02-03T16:41:25Z

@guillaumep
Apologies for that. Usually PRs are not reviewed unless if marked as review (changed to an actual PR). If you would like help with your build issues, feel free to rebase and we can get you the assistance you need.

linux-foundation-easycla · 2022-08-26T15:03:53Z

The committers listed above are authorized under a signed CLA.

✅ login: guillaumep (6cabf98)

guillaumep · 2022-08-26T22:07:47Z

tox.ini

@@ -119,6 +119,10 @@ envlist =
    py3{7,8,9,10}-test-instrumentation-pymongo
    pypy3-test-instrumentation-pymongo

+    ; opentelemetry-instrumentation-pymssql
+    py3{7,8,9,10}-test-instrumentation-pymssql
+    ; instrumentation-pymssql intentionally excluded from pypy3


pymssql has no pypy support:

pymssql/pymssql#517

If you could add that link in the file as a comment that'd be good.

Please link this in the tox file.

guillaumep · 2022-08-26T22:56:23Z

@lzchen now ready for review!

lzchen · 2022-08-30T19:44:06Z

@guillaumep
Thanks for the contribution. Would you be willing to add yourself as an owner for this component under here?

...n/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/package.py

lzchen · 2022-08-30T19:50:03Z

Please add an entry to the README

.../opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py

lzchen · 2022-08-30T19:52:44Z

.../opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py

+    cnx.close()
+
+API
+---


Please add a section for configuration like here

Is this done? tracer_provider can still be configured.

lzchen · 2022-08-30T19:53:26Z

.../opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py

+        https://github.com/pymssql/pymssql/
+        """
+        tracer_provider = kwargs.get("tracer_provider")
+


Are request_hook and response_hook going to be supported?

I based my code on pymysql which does not support these hooks. Can we consider this an improvement request that could be done in a future PR?

That's fine. Could you create a new issue to track this to be done?

.../opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py

guillaumep · 2022-09-01T15:21:18Z

@lzchen currently working on the comments. Would you prefer I rebase, modify my current commit and force push on my branche, or would you rather like to have a new commit that addresses the comments?

guillaumep · 2022-09-02T19:36:52Z

@lzchen All comments addressed.

lzchen · 2022-09-08T17:38:18Z

Changes look good. Just a couple of outstanding comments. Also please fix the builds :)

srikanthccv · 2023-01-06T16:51:00Z

@guillaumep we are almost near to getting this merged. Please fix the tests and address the outstanding comments.

nemoshlag · 2023-01-06T19:29:22Z

docs/instrumentation/pymssql/pymssql.rst

+OpenTelemetry pymssql Instrumentation
+=====================================
+
+.. automodule:: opentelemetry.instrumentation.pymssql


Pls add the relevant needed pymssql version to docs-requirements.txt - This can be verified using tox -e docs

nemoshlag · 2023-02-05T14:38:35Z

CHANGELOG.md

@@ -68,6 +68,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `opentelemetry-instrumentation-confluent-kafka` Add support for the latest versions of the library.
  ([#1468](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/1468))

+### Added


Please move this to the Unreleased section

guillaumep requested review from a team, owais and lzchen and removed request for a team April 1, 2021 19:03

guillaumep marked this pull request as draft April 1, 2021 19:28

guillaumep force-pushed the instrument_pymssql branch from 0860e38 to 92d7340 Compare April 7, 2021 04:03

guillaumep commented Apr 7, 2021

View reviewed changes

guillaumep force-pushed the instrument_pymssql branch from 92d7340 to faeea0a Compare July 22, 2021 17:48

guillaumep force-pushed the instrument_pymssql branch 3 times, most recently from 0e2df03 to b93ad00 Compare July 22, 2021 18:57

guillaumep force-pushed the instrument_pymssql branch 2 times, most recently from 17d054f to 0333424 Compare August 26, 2022 15:03

guillaumep force-pushed the instrument_pymssql branch 4 times, most recently from 96980a5 to 4cc4753 Compare August 26, 2022 22:06

guillaumep commented Aug 26, 2022

View reviewed changes

guillaumep marked this pull request as ready for review August 26, 2022 22:55

guillaumep changed the title ~~[WIP] Add pymssql instrumentation~~ Add pymssql instrumentation Aug 26, 2022

lzchen reviewed Aug 30, 2022

View reviewed changes

...n/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/package.py Outdated Show resolved Hide resolved

lzchen reviewed Aug 30, 2022

View reviewed changes

.../opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py Outdated Show resolved Hide resolved

lzchen reviewed Aug 30, 2022

View reviewed changes

.../opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py Outdated Show resolved Hide resolved

lzchen reviewed Aug 30, 2022

View reviewed changes

.../opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py Show resolved Hide resolved

guillaumep force-pushed the instrument_pymssql branch 2 times, most recently from 4a114eb to 9d87d8e Compare September 2, 2022 19:19

github-actions bot assigned guillaumep Sep 2, 2022

Add pymssql instrumentation

22363db

guillaumep force-pushed the instrument_pymssql branch from 9d87d8e to 22363db Compare September 2, 2022 19:36

Merge branch 'main' into instrument_pymssql

58b104e

srikanthccv added 2 commits December 10, 2022 07:34

Merge branch 'main' into instrument_pymssql

8e2ea31

Merge branch 'main' into instrument_pymssql

d5cb9f0

github-actions bot assigned nemoshlag Jan 6, 2023

github-actions bot requested a review from nemoshlag January 6, 2023 16:50

nemoshlag reviewed Jan 6, 2023

View reviewed changes

Merge branch 'main' into instrument_pymssql

6ec7b7b

srikanthccv requested review from nemoshlag and lzchen February 4, 2023 19:22

nemoshlag reviewed Feb 5, 2023

View reviewed changes

Merge branch 'main' into instrument_pymssql

9b925bb

dacevedo12 mentioned this pull request May 2, 2023

Instrumentation acceptance policy and general guidelines for external instrumentation authors #1714

Open

xrmx mentioned this pull request Mar 14, 2024

Add pymssql instrumentation elastic/elastic-otel-python#10

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add pymssql instrumentation #394

Add pymssql instrumentation #394

guillaumep commented Apr 1, 2021 •

edited

Loading

linux-foundation-easycla bot commented Apr 1, 2021 •

edited

Loading

guillaumep commented Apr 1, 2021

guillaumep commented Apr 1, 2021 •

edited

Loading

guillaumep commented Apr 7, 2021

guillaumep Apr 7, 2021

linux-foundation-easycla bot commented Jul 22, 2021 •

edited

Loading

lzchen commented Feb 2, 2022

guillaumep commented Feb 2, 2022 •

edited

Loading

lzchen commented Feb 3, 2022 •

edited

Loading

linux-foundation-easycla bot commented Aug 26, 2022 •

edited

Loading

guillaumep Aug 26, 2022

lzchen Aug 30, 2022

lzchen Sep 8, 2022

guillaumep commented Aug 26, 2022

lzchen commented Aug 30, 2022

lzchen commented Aug 30, 2022

lzchen Aug 30, 2022

lzchen Sep 8, 2022

lzchen Aug 30, 2022

guillaumep Sep 2, 2022

lzchen Sep 8, 2022

guillaumep commented Sep 1, 2022

guillaumep commented Sep 2, 2022

lzchen commented Sep 8, 2022

srikanthccv commented Jan 6, 2023

nemoshlag Jan 6, 2023

nemoshlag Feb 5, 2023

Add pymssql instrumentation #394

Are you sure you want to change the base?

Add pymssql instrumentation #394

Conversation

guillaumep commented Apr 1, 2021 • edited Loading

Description

Type of change

How Has This Been Tested?

Does This PR Require a Core Repo Change?

Checklist:

linux-foundation-easycla bot commented Apr 1, 2021 • edited Loading

guillaumep commented Apr 1, 2021

guillaumep commented Apr 1, 2021 • edited Loading

guillaumep commented Apr 7, 2021

Choose a reason for hiding this comment

linux-foundation-easycla bot commented Jul 22, 2021 • edited Loading

lzchen commented Feb 2, 2022

guillaumep commented Feb 2, 2022 • edited Loading

lzchen commented Feb 3, 2022 • edited Loading

linux-foundation-easycla bot commented Aug 26, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guillaumep commented Aug 26, 2022

lzchen commented Aug 30, 2022

lzchen commented Aug 30, 2022

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guillaumep commented Sep 1, 2022

guillaumep commented Sep 2, 2022

lzchen commented Sep 8, 2022

srikanthccv commented Jan 6, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

guillaumep commented Apr 1, 2021 •

edited

Loading

linux-foundation-easycla bot commented Apr 1, 2021 •

edited

Loading

guillaumep commented Apr 1, 2021 •

edited

Loading

linux-foundation-easycla bot commented Jul 22, 2021 •

edited

Loading

guillaumep commented Feb 2, 2022 •

edited

Loading

lzchen commented Feb 3, 2022 •

edited

Loading

linux-foundation-easycla bot commented Aug 26, 2022 •

edited

Loading