docs: Clarify that `instrumenter` is internal-only #3299

szokeasaurusrex · 2024-07-17T14:31:56Z

Adjust docstrings of all non-deprecated functions which take an instrumenter parameter to state that instrumenter is only meant to be used by the SDK, and that it is deprecated for client code. The docstrings also inform users that instrumenter will be removed in the next major release.

codecov · 2024-07-17T14:58:24Z

Test Failures Detected: Due to failing tests, we cannot provide coverage reports at this time.

❌ Failed Test Results:

Completed 13439 tests with 3 failed, 11690 passed and 1746 skipped.

View the full list of failed tests

py3.12-common

Class name: tests.test_utils
Test name: test_installed_modules

tests/test_utils.py:538: in test_installed_modules
    assert installed_distributions == importlib_distributions
E   AssertionError: assert {'asttokens': '2.4.1',\n 'attrs': '23.2.0',\n 'certifi': '2024.7.4',\n 'charset-normalizer': '3.3.2',\n 'colorama': '0.4.6',\n 'coverage': '7.6.0',\n 'docopt': '0.6.2',\n 'executing': '2.0.1',\n 'idna': '3.7',\n 'iniconfig': '2.0.0',\n 'jsonschema': '4.23.0',\n 'jsonschema-specifications': '2023.12.1',\n 'markupsafe': '2.1.5',\n 'packaging': '24.1',\n 'pip': '24.0',\n 'pluggy': '1.5.0',\n 'py': '1.11.0',\n 'pyrsistent': '0.20.0',\n 'pysocks': '1.7.1',\n 'pytest': '6.2.5',\n 'pytest-asyncio': '0.20.3',\n 'pytest-cov': '5.0.0',\n 'pytest-forked': '1.6.0',\n 'pytest-localserver': '0.8.1',\n 'pytest-watch': '4.2.0',\n 'pyyaml': '6.0.1',\n 'referencing': '0.35.1',\n 'requests': '2.32.3',\n 'responses': '0.25.3',\n 'rpds-py': '0.19.0',\n 'sentry-sdk': '2.10.0',\n 'setuptools': '71.0.3',\n 'six': '1.16.0',\n 'toml': '0.10.2',\n 'urllib3': '2.2.2',\n 'watchdog': '4.0.1',\n 'werkzeug': '3.0.3'} == {'asttokens': '2.4.1',\n 'attrs': '23.2.0',\n 'autocommand': '2.2.2',\n 'backports-tarfile': '1.2.0',\n 'certifi': '2024.7.4',\n 'charset-normalizer': '3.3.2',\n 'colorama': '0.4.6',\n 'coverage': '7.6.0',\n 'docopt': '0.6.2',\n 'executing': '2.0.1',\n 'idna': '3.7',\n 'importlib-metadata': '8.0.0',\n 'importlib-resources': '6.4.0',\n 'inflect': '7.3.1',\n 'iniconfig': '2.0.0',\n 'jaraco-context': '5.3.0',\n 'jaraco-functools': '4.0.1',\n 'jaraco-text': '3.12.1',\n 'jsonschema': '4.23.0',\n 'jsonschema-specifications': '2023.12.1',\n 'markupsafe': '2.1.5',\n 'more-itertools': '10.3.0',\n 'ordered-set': '4.1.0',\n 'packaging': '24.1',\n 'pip': '24.0',\n 'platformdirs': '4.2.2',\n 'pluggy': '1.5.0',\n 'py': '1.11.0',\n 'pyrsistent': '0.20.0',\n 'pysocks': '1.7.1',\n 'pytest': '6.2.5',\n 'pytest-asyncio': '0.20.3',\n 'pytest-cov': '5.0.0',\n 'pytest-forked': '1.6.0',\n 'pytest-localserver': '0.8.1',\n 'pytest-watch': '4.2.0',\n 'pyyaml': '6.0.1',\n 'referencing': '0.35.1',\n 'requests': '2.32.3',\n 'responses': '0.25.3',\n 'rpds-py': '0.19.0',\n 'sentry-sdk': '2.10.0',\n 'setuptools': '71.0.3',\n 'six': '1.16.0',\n 'toml': '0.10.2',\n 'tomli': '2.0.1',\n 'typeguard': '4.3.0',\n 'typing-extensions': '4.12.2',\n 'urllib3': '2.2.2',\n 'watchdog': '4.0.1',\n 'werkzeug': '3.0.3',\n 'wheel': '0.43.0',\n 'zipp': '3.19.2'}
E     Common items:
E     {'asttokens': '2.4.1',
E      'attrs': '23.2.0',
E      'certifi': '2024.7.4',
E      'charset-normalizer': '3.3.2',
E      'colorama': '0.4.6',
E      'coverage': '7.6.0',
E      'docopt': '0.6.2',
E      'executing': '2.0.1',
E      'idna': '3.7',
E      'iniconfig': '2.0.0',
E      'jsonschema': '4.23.0',
E      'jsonschema-specifications': '2023.12.1',
E      'markupsafe': '2.1.5',
E      'packaging': '24.1',
E      'pip': '24.0',
E      'pluggy': '1.5.0',
E      'py': '1.11.0',
E      'pyrsistent': '0.20.0',
E      'pysocks': '1.7.1',
E      'pytest': '6.2.5',
E      'pytest-asyncio': '0.20.3',
E      'pytest-cov': '5.0.0',
E      'pytest-forked': '1.6.0',
E      'pytest-localserver': '0.8.1',
E      'pytest-watch': '4.2.0',
E      'pyyaml': '6.0.1',
E      'referencing': '0.35.1',
E      'requests': '2.32.3',
E      'responses': '0.25.3',
E      'rpds-py': '0.19.0',
E      'sentry-sdk': '2.10.0',
E      'setuptools': '71.0.3',
E      'six': '1.16.0',
E      'toml': '0.10.2',
E      'urllib3': '2.2.2',
E      'watchdog': '4.0.1',
E      'werkzeug': '3.0.3'}
E     Right contains 16 more items:
E     {'autocommand': '2.2.2',
E      'backports-tarfile': '1.2.0',
E      'importlib-metadata': '8.0.0',
E      'importlib-resources': '6.4.0',
E      'inflect': '7.3.1',
E      'jaraco-context': '5.3.0',
E      'jaraco-functools': '4.0.1',
E      'jaraco-text': '3.12.1',
E      'more-itertools': '10.3.0',
E      'ordered-set': '4.1.0',
E      'platformdirs': '4.2.2',
E      'tomli': '2.0.1',
E      'typeguard': '4.3.0',
E      'typing-extensions': '4.12.2',
E      'wheel': '0.43.0',
E      'zipp': '3.19.2'}
E     Full diff:
E       {
E        'asttokens': '2.4.1',
E        'attrs': '23.2.0',
E     -  'autocommand': '2.2.2',
E     -  'backports-tarfile': '1.2.0',
E        'certifi': '2024.7.4',
E        'charset-normalizer': '3.3.2',
E        'colorama': '0.4.6',
E        'coverage': '7.6.0',
E        'docopt': '0.6.2',
E        'executing': '2.0.1',
E        'idna': '3.7',
E     -  'importlib-metadata': '8.0.0',
E     -  'importlib-resources': '6.4.0',
E     -  'inflect': '7.3.1',
E        'iniconfig': '2.0.0',
E     -  'jaraco-context': '5.3.0',
E     -  'jaraco-functools': '4.0.1',
E     -  'jaraco-text': '3.12.1',
E        'jsonschema': '4.23.0',
E        'jsonschema-specifications': '2023.12.1',
E        'markupsafe': '2.1.5',
E     -  'more-itertools': '10.3.0',
E     -  'ordered-set': '4.1.0',
E        'packaging': '24.1',
E        'pip': '24.0',
E     -  'platformdirs': '4.2.2',
E        'pluggy': '1.5.0',
E        'py': '1.11.0',
E        'pyrsistent': '0.20.0',
E        'pysocks': '1.7.1',
E        'pytest': '6.2.5',
E        'pytest-asyncio': '0.20.3',
E        'pytest-cov': '5.0.0',
E        'pytest-forked': '1.6.0',
E        'pytest-localserver': '0.8.1',
E        'pytest-watch': '4.2.0',
E        'pyyaml': '6.0.1',
E        'referencing': '0.35.1',
E        'requests': '2.32.3',
E        'responses': '0.25.3',
E        'rpds-py': '0.19.0',
E        'sentry-sdk': '2.10.0',
E        'setuptools': '71.0.3',
E        'six': '1.16.0',
E        'toml': '0.10.2',
E     -  'tomli': '2.0.1',
E     -  'typeguard': '4.3.0',
E     -  'typing-extensions': '4.12.2',
E        'urllib3': '2.2.2',
E        'watchdog': '4.0.1',
E        'werkzeug': '3.0.3',
E     -  'wheel': '0.43.0',
E     -  'zipp': '3.19.2',
E       }

py3.12-gevent

Class name: tests.test_utils
Test name: test_installed_modules

tests/test_utils.py:538: in test_installed_modules
    assert installed_distributions == importlib_distributions
E   AssertionError: assert {'asttokens': '2.4.1',\n 'attrs': '23.2.0',\n 'certifi': '2024.7.4',\n 'charset-normalizer': '3.3.2',\n 'colorama': '0.4.6',\n 'coverage': '7.6.0',\n 'docopt': '0.6.2',\n 'executing': '2.0.1',\n 'gevent': '24.2.1',\n 'greenlet': '3.0.3',\n 'idna': '3.7',\n 'iniconfig': '2.0.0',\n 'jsonschema': '4.23.0',\n 'jsonschema-specifications': '2023.12.1',\n 'markupsafe': '2.1.5',\n 'packaging': '24.1',\n 'pip': '24.0',\n 'pluggy': '1.5.0',\n 'py': '1.11.0',\n 'pyrsistent': '0.20.0',\n 'pysocks': '1.7.1',\n 'pytest': '6.2.5',\n 'pytest-cov': '5.0.0',\n 'pytest-forked': '1.6.0',\n 'pytest-localserver': '0.8.1',\n 'pytest-watch': '4.2.0',\n 'pyyaml': '6.0.1',\n 'referencing': '0.35.1',\n 'requests': '2.32.3',\n 'responses': '0.25.3',\n 'rpds-py': '0.19.0',\n 'sentry-sdk': '2.10.0',\n 'setuptools': '71.0.3',\n 'six': '1.16.0',\n 'toml': '0.10.2',\n 'urllib3': '2.2.2',\n 'watchdog': '4.0.1',\n 'werkzeug': '3.0.3',\n 'zope-event': '5.0',\n 'zope-interface': '6.4.post2'} == {'asttokens': '2.4.1',\n 'attrs': '23.2.0',\n 'autocommand': '2.2.2',\n 'backports-tarfile': '1.2.0',\n 'certifi': '2024.7.4',\n 'charset-normalizer': '3.3.2',\n 'colorama': '0.4.6',\n 'coverage': '7.6.0',\n 'docopt': '0.6.2',\n 'executing': '2.0.1',\n 'gevent': '24.2.1',\n 'greenlet': '3.0.3',\n 'idna': '3.7',\n 'importlib-metadata': '8.0.0',\n 'importlib-resources': '6.4.0',\n 'inflect': '7.3.1',\n 'iniconfig': '2.0.0',\n 'jaraco-context': '5.3.0',\n 'jaraco-functools': '4.0.1',\n 'jaraco-text': '3.12.1',\n 'jsonschema': '4.23.0',\n 'jsonschema-specifications': '2023.12.1',\n 'markupsafe': '2.1.5',\n 'more-itertools': '10.3.0',\n 'ordered-set': '4.1.0',\n 'packaging': '24.1',\n 'pip': '24.0',\n 'platformdirs': '4.2.2',\n 'pluggy': '1.5.0',\n 'py': '1.11.0',\n 'pyrsistent': '0.20.0',\n 'pysocks': '1.7.1',\n 'pytest': '6.2.5',\n 'pytest-cov': '5.0.0',\n 'pytest-forked': '1.6.0',\n 'pytest-localserver': '0.8.1',\n 'pytest-watch': '4.2.0',\n 'pyyaml': '6.0.1',\n 'referencing': '0.35.1',\n 'requests': '2.32.3',\n 'responses': '0.25.3',\n 'rpds-py': '0.19.0',\n 'sentry-sdk': '2.10.0',\n 'setuptools': '71.0.3',\n 'six': '1.16.0',\n 'toml': '0.10.2',\n 'tomli': '2.0.1',\n 'typeguard': '4.3.0',\n 'typing-extensions': '4.12.2',\n 'urllib3': '2.2.2',\n 'watchdog': '4.0.1',\n 'werkzeug': '3.0.3',\n 'wheel': '0.43.0',\n 'zipp': '3.19.2',\n 'zope-event': '5.0',\n 'zope-interface': '6.4.post2'}
E     Common items:
E     {'asttokens': '2.4.1',
E      'attrs': '23.2.0',
E      'certifi': '2024.7.4',
E      'charset-normalizer': '3.3.2',
E      'colorama': '0.4.6',
E      'coverage': '7.6.0',
E      'docopt': '0.6.2',
E      'executing': '2.0.1',
E      'gevent': '24.2.1',
E      'greenlet': '3.0.3',
E      'idna': '3.7',
E      'iniconfig': '2.0.0',
E      'jsonschema': '4.23.0',
E      'jsonschema-specifications': '2023.12.1',
E      'markupsafe': '2.1.5',
E      'packaging': '24.1',
E      'pip': '24.0',
E      'pluggy': '1.5.0',
E      'py': '1.11.0',
E      'pyrsistent': '0.20.0',
E      'pysocks': '1.7.1',
E      'pytest': '6.2.5',
E      'pytest-cov': '5.0.0',
E      'pytest-forked': '1.6.0',
E      'pytest-localserver': '0.8.1',
E      'pytest-watch': '4.2.0',
E      'pyyaml': '6.0.1',
E      'referencing': '0.35.1',
E      'requests': '2.32.3',
E      'responses': '0.25.3',
E      'rpds-py': '0.19.0',
E      'sentry-sdk': '2.10.0',
E      'setuptools': '71.0.3',
E      'six': '1.16.0',
E      'toml': '0.10.2',
E      'urllib3': '2.2.2',
E      'watchdog': '4.0.1',
E      'werkzeug': '3.0.3',
E      'zope-event': '5.0',
E      'zope-interface': '6.4.post2'}
E     Right contains 16 more items:
E     {'autocommand': '2.2.2',
E      'backports-tarfile': '1.2.0',
E      'importlib-metadata': '8.0.0',
E      'importlib-resources': '6.4.0',
E      'inflect': '7.3.1',
E      'jaraco-context': '5.3.0',
E      'jaraco-functools': '4.0.1',
E      'jaraco-text': '3.12.1',
E      'more-itertools': '10.3.0',
E      'ordered-set': '4.1.0',
E      'platformdirs': '4.2.2',
E      'tomli': '2.0.1',
E      'typeguard': '4.3.0',
E      'typing-extensions': '4.12.2',
E      'wheel': '0.43.0',
E      'zipp': '3.19.2'}
E     Full diff:
E       {
E        'asttokens': '2.4.1',
E        'attrs': '23.2.0',
E     -  'autocommand': '2.2.2',
E     -  'backports-tarfile': '1.2.0',
E        'certifi': '2024.7.4',
E        'charset-normalizer': '3.3.2',
E        'colorama': '0.4.6',
E        'coverage': '7.6.0',
E        'docopt': '0.6.2',
E        'executing': '2.0.1',
E        'gevent': '24.2.1',
E        'greenlet': '3.0.3',
E        'idna': '3.7',
E     -  'importlib-metadata': '8.0.0',
E     -  'importlib-resources': '6.4.0',
E     -  'inflect': '7.3.1',
E        'iniconfig': '2.0.0',
E     -  'jaraco-context': '5.3.0',
E     -  'jaraco-functools': '4.0.1',
E     -  'jaraco-text': '3.12.1',
E        'jsonschema': '4.23.0',
E        'jsonschema-specifications': '2023.12.1',
E        'markupsafe': '2.1.5',
E     -  'more-itertools': '10.3.0',
E     -  'ordered-set': '4.1.0',
E        'packaging': '24.1',
E        'pip': '24.0',
E     -  'platformdirs': '4.2.2',
E        'pluggy': '1.5.0',
E        'py': '1.11.0',
E        'pyrsistent': '0.20.0',
E        'pysocks': '1.7.1',
E        'pytest': '6.2.5',
E        'pytest-cov': '5.0.0',
E        'pytest-forked': '1.6.0',
E        'pytest-localserver': '0.8.1',
E        'pytest-watch': '4.2.0',
E        'pyyaml': '6.0.1',
E        'referencing': '0.35.1',
E        'requests': '2.32.3',
E        'responses': '0.25.3',
E        'rpds-py': '0.19.0',
E        'sentry-sdk': '2.10.0',
E        'setuptools': '71.0.3',
E        'six': '1.16.0',
E        'toml': '0.10.2',
E     -  'tomli': '2.0.1',
E     -  'typeguard': '4.3.0',
E     -  'typing-extensions': '4.12.2',
E        'urllib3': '2.2.2',
E        'watchdog': '4.0.1',
E        'werkzeug': '3.0.3',
E     -  'wheel': '0.43.0',
E     -  'zipp': '3.19.2',
E        'zope-event': '5.0',
E        'zope-interface': '6.4.post2',
E       }

py3.13-common

Class name: tests.test_utils
Test name: test_installed_modules

tests/test_utils.py:538: in test_installed_modules
    assert installed_distributions == importlib_distributions
E   AssertionError: assert {'sentry-sdk': '2.10.0', 'rpds-py': '0.19.0', 'pysocks': '1.7.1', 'watchdog': '4.0.1', 'iniconfig': '2.0.0', 'pluggy': '1.5.0', 'executing': '2.0.1', 'idna': '3.7', 'referencing': '0.35.1', 'responses': '0.25.3', 'jsonschema': '4.23.0', 'py': '1.11.0', 'colorama': '0.4.6', 'certifi': '2024.7.4', 'packaging': '24.1', 'pytest-asyncio': '0.23.8', 'werkzeug': '3.0.3', 'pytest-localserver': '0.8.1', 'pyrsistent': '0.20.0', 'pytest-forked': '1.6.0', 'setuptools': '71.0.3', 'six': '1.16.0', 'markupsafe': '2.1.5', 'pytest': '8.2.2', 'pytest-cov': '5.0.0', 'charset-normalizer': '3.3.2', 'asttokens': '2.4.1', 'docopt': '0.6.2', 'coverage': '7.6.0', 'requests': '2.32.3', 'pip': '24.0', 'jsonschema-specifications': '2023.12.1', 'pyyaml': '6.0.1', 'urllib3': '2.2.2', 'pytest-watch': '4.2.0', 'attrs': '23.2.0'} == {'sentry-sdk': '2.10.0', 'rpds-py': '0.19.0', 'pysocks': '1.7.1', 'watchdog': '4.0.1', 'iniconfig': '2.0.0', 'pluggy': '1.5.0', 'executing': '2.0.1', 'idna': '3.7', 'referencing': '0.35.1', 'responses': '0.25.3', 'jsonschema': '4.23.0', 'py': '1.11.0', 'colorama': '0.4.6', 'certifi': '2024.7.4', 'packaging': '24.1', 'pytest-asyncio': '0.23.8', 'werkzeug': '3.0.3', 'pytest-localserver': '0.8.1', 'pyrsistent': '0.20.0', 'pytest-forked': '1.6.0', 'setuptools': '71.0.3', 'six': '1.16.0', 'markupsafe': '2.1.5', 'pytest': '8.2.2', 'pytest-cov': '5.0.0', 'charset-normalizer': '3.3.2', 'asttokens': '2.4.1', 'docopt': '0.6.2', 'coverage': '7.6.0', 'requests': '2.32.3', 'pip': '24.0', 'jsonschema-specifications': '2023.12.1', 'pyyaml': '6.0.1', 'urllib3': '2.2.2', 'pytest-watch': '4.2.0', 'attrs': '23.2.0', 'jaraco-context': '5.3.0', 'jaraco-functools': '4.0.1', 'typing-extensions': '4.12.2', 'backports-tarfile': '1.2.0', 'tomli': '2.0.1', 'inflect': '7.3.1', 'jaraco-text': '3.12.1', 'importlib-resources': '6.4.0', 'importlib-metadata': '8.0.0', 'more-itertools': '10.3.0', 'typeguard': '4.3.0', 'autocommand': '2.2.2', 'platformdirs': '4.2.2', 'ordered-set': '4.1.0', 'zipp': '3.19.2', 'wheel': '0.43.0'}
E     
E     Common items:
E     {'asttokens': '2.4.1',
E      'attrs': '23.2.0',
E      'certifi': '2024.7.4',
E      'charset-normalizer': '3.3.2',
E      'colorama': '0.4.6',
E      'coverage': '7.6.0',
E      'docopt': '0.6.2',
E      'executing': '2.0.1',
E      'idna': '3.7',
E      'iniconfig': '2.0.0',
E      'jsonschema': '4.23.0',
E      'jsonschema-specifications': '2023.12.1',
E      'markupsafe': '2.1.5',
E      'packaging': '24.1',
E      'pip': '24.0',
E      'pluggy': '1.5.0',
E      'py': '1.11.0',
E      'pyrsistent': '0.20.0',
E      'pysocks': '1.7.1',
E      'pytest': '8.2.2',
E      'pytest-asyncio': '0.23.8',
E      'pytest-cov': '5.0.0',
E      'pytest-forked': '1.6.0',
E      'pytest-localserver': '0.8.1',
E      'pytest-watch': '4.2.0',
E      'pyyaml': '6.0.1',
E      'referencing': '0.35.1',
E      'requests': '2.32.3',
E      'responses': '0.25.3',
E      'rpds-py': '0.19.0',
E      'sentry-sdk': '2.10.0',
E      'setuptools': '71.0.3',
E      'six': '1.16.0',
E      'urllib3': '2.2.2',
E      'watchdog': '4.0.1',
E      'werkzeug': '3.0.3'}
E     Right contains 16 more items:
E     {'autocommand': '2.2.2',
E      'backports-tarfile': '1.2.0',
E      'importlib-metadata': '8.0.0',
E      'importlib-resources': '6.4.0',
E      'inflect': '7.3.1',
E      'jaraco-context': '5.3.0',
E      'jaraco-functools': '4.0.1',
E      'jaraco-text': '3.12.1',
E      'more-itertools': '10.3.0',
E      'ordered-set': '4.1.0',
E      'platformdirs': '4.2.2',
E      'tomli': '2.0.1',
E      'typeguard': '4.3.0',
E      'typing-extensions': '4.12.2',
E      'wheel': '0.43.0',
E      'zipp': '3.19.2'}
E     
E     Full diff:
E       {
E           'asttokens': '2.4.1',
E           'attrs': '23.2.0',
E     -     'autocommand': '2.2.2',
E     -     'backports-tarfile': '1.2.0',
E           'certifi': '2024.7.4',
E           'charset-normalizer': '3.3.2',
E           'colorama': '0.4.6',
E           'coverage': '7.6.0',
E           'docopt': '0.6.2',
E           'executing': '2.0.1',
E           'idna': '3.7',
E     -     'importlib-metadata': '8.0.0',
E     -     'importlib-resources': '6.4.0',
E     -     'inflect': '7.3.1',
E           'iniconfig': '2.0.0',
E     -     'jaraco-context': '5.3.0',
E     -     'jaraco-functools': '4.0.1',
E     -     'jaraco-text': '3.12.1',
E           'jsonschema': '4.23.0',
E           'jsonschema-specifications': '2023.12.1',
E           'markupsafe': '2.1.5',
E     -     'more-itertools': '10.3.0',
E     -     'ordered-set': '4.1.0',
E           'packaging': '24.1',
E           'pip': '24.0',
E     -     'platformdirs': '4.2.2',
E           'pluggy': '1.5.0',
E           'py': '1.11.0',
E           'pyrsistent': '0.20.0',
E           'pysocks': '1.7.1',
E           'pytest': '8.2.2',
E           'pytest-asyncio': '0.23.8',
E           'pytest-cov': '5.0.0',
E           'pytest-forked': '1.6.0',
E           'pytest-localserver': '0.8.1',
E           'pytest-watch': '4.2.0',
E           'pyyaml': '6.0.1',
E           'referencing': '0.35.1',
E           'requests': '2.32.3',
E           'responses': '0.25.3',
E           'rpds-py': '0.19.0',
E           'sentry-sdk': '2.10.0',
E           'setuptools': '71.0.3',
E           'six': '1.16.0',
E     -     'tomli': '2.0.1',
E     -     'typeguard': '4.3.0',
E     -     'typing-extensions': '4.12.2',
E           'urllib3': '2.2.2',
E           'watchdog': '4.0.1',
E           'werkzeug': '3.0.3',
E     -     'wheel': '0.43.0',
E     -     'zipp': '3.19.2',
E       }

sentrivana · 2024-07-18T09:24:27Z

sentry_sdk/client.py

+        warnings.warn(
+            "The `instrumenter` option will be removed in the next major version.",
+            DeprecationWarning,
+            stacklevel=3,
+        )


This will also emit deprecation warnings for people using OTel now, right? The problem with that is that there is nothing actionable for the user here -- they can't do anything to get rid of the warning. So they'll be pestered by this message that basically says "you're using the SDK wrong" and can't do anything about it.

I'd either get rid of the warning completely, or give it a bit more context so that folks know what to expect ("...the option will be removed since OpenTelemetry tracing will become the default" or something like that).

Yeah fair point, I am not really sure the best way to go about this. The downside of no warning is that we will drop this option without ever having had a depreciation warning for it – the downside of including the warning is that people might be confused about what action they need to take.

Maybe we should just highlight in the docs that instrumenter will be removed in the next major? Perhaps, we can also plan to add a deprecation warning in the final 2.x minor/patch release?

I like your suggestions!

Okay, this is what I will do: I will split the deprecation warning into a separate PR that we can keep around for when we add it in the final 2.x release. This PR will only contain the docstring updates to clarify that we will be dropping instrumenter in 3.x. Then, I will prepare a docs PR

Deprecation PR is here: #3308

Adjust docstrings of all non-deprecated functions which take an `instrumenter` parameter to state that `instrumenter` is only meant to be used by the SDK, and that it is deprecated for client code. The docstrings also inform users that `instrumenter` will be removed in the next major release.

szokeasaurusrex requested review from antonpirker and sentrivana July 17, 2024 14:31

szokeasaurusrex force-pushed the szokeasaurusrex/instrumenter-deprecation branch from 0e2ba1d to 330985a Compare July 18, 2024 09:00

sentrivana reviewed Jul 18, 2024

View reviewed changes

szokeasaurusrex force-pushed the szokeasaurusrex/instrumenter-deprecation branch from 330985a to 3533784 Compare July 19, 2024 09:21

szokeasaurusrex changed the title ~~feat: Deprecate the instrumenter init option~~ docs: Clarify that instrumenter is internal-only Jul 19, 2024

szokeasaurusrex requested a review from sentrivana July 19, 2024 09:22

sentrivana approved these changes Jul 19, 2024

View reviewed changes

szokeasaurusrex force-pushed the szokeasaurusrex/instrumenter-deprecation branch 2 times, most recently from 4ad56dc to 825b2b9 Compare July 19, 2024 11:47

szokeasaurusrex enabled auto-merge (squash) July 19, 2024 11:47

szokeasaurusrex merged commit 93a3242 into master Jul 19, 2024
123 checks passed

szokeasaurusrex deleted the szokeasaurusrex/instrumenter-deprecation branch July 19, 2024 11:56

szokeasaurusrex mentioned this pull request Jul 22, 2024

Deprecate and reduce instrumenter usage internally #3151

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Clarify that `instrumenter` is internal-only #3299

docs: Clarify that `instrumenter` is internal-only #3299

szokeasaurusrex commented Jul 17, 2024 •

edited

Loading

codecov bot commented Jul 17, 2024 •

edited

Loading

py3.12-common

py3.12-gevent

py3.13-common

sentrivana Jul 18, 2024

szokeasaurusrex Jul 18, 2024 •

edited

Loading

sentrivana Jul 18, 2024

szokeasaurusrex Jul 19, 2024

szokeasaurusrex Jul 19, 2024

docs: Clarify that instrumenter is internal-only #3299

docs: Clarify that instrumenter is internal-only #3299

Conversation

szokeasaurusrex commented Jul 17, 2024 • edited Loading

codecov bot commented Jul 17, 2024 • edited Loading

❌ Failed Test Results:

py3.12-common

py3.12-gevent

py3.13-common

sentrivana Jul 18, 2024

Choose a reason for hiding this comment

szokeasaurusrex Jul 18, 2024 • edited Loading

Choose a reason for hiding this comment

sentrivana Jul 18, 2024

Choose a reason for hiding this comment

szokeasaurusrex Jul 19, 2024

Choose a reason for hiding this comment

szokeasaurusrex Jul 19, 2024

Choose a reason for hiding this comment

docs: Clarify that `instrumenter` is internal-only #3299

docs: Clarify that `instrumenter` is internal-only #3299

szokeasaurusrex commented Jul 17, 2024 •

edited

Loading

codecov bot commented Jul 17, 2024 •

edited

Loading

szokeasaurusrex Jul 18, 2024 •

edited

Loading