cassandra: use _instruments_any instead of _instruments for driver deps by andreamatt · Pull Request #4182 · open-telemetry/opentelemetry-python-contrib

andreamatt · 2026-02-09T16:40:57Z

Description

The cassandra instrumentation listed both cassandra-driver and scylla-driver in _instruments, which requires all listed packages to be installed. Since users install one or the other (they are alternative drivers for the same cassandra.cluster API), this should use _instruments_any so that having either driver installed is sufficient.

This follows the same pattern already used by the psycopg2 and kafka-python instrumentations, introduced in #3610. Cassandra was the only remaining instrumentation with multiple alternative packages listed under _instruments instead of _instruments_any.

Also splits test requirements into separate files for each driver and adds separate tox/CI environments to test both independently.

Fixes #2819

Type of change

Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Verified original code fails with DependencyConflict: requested: "scylla-driver ~= 3.25" but found: "None" when only cassandra-driver is installed (3/4 tests fail)
Verified fix allows instrumentation to work with either driver installed (8/8 tests pass)
Added unit tests for instrumentation_dependencies() covering all four cases: only cassandra-driver, only scylla-driver, both installed, neither installed
Split test requirements and tox environments; both pass:
- py313-test-instrumentation-cassandra-driver: 8/8 passed
- py312-test-instrumentation-cassandra-scylla: 8/8 passed
Ran tox -e generate and tox -e generate-workflows to regenerate files

Does This PR Require a Core Repo Change?

No.

Checklist:

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

Followed the style guidelines of this project
Changelogs have been updated
Unit tests have been added
Documentation has been updated

linux-foundation-easycla · 2026-02-09T16:41:10Z

The committers listed above are authorized under a signed CLA.

✅ login: andreamatt / name: Andrea Mattè (de3f0f8)
✅ login: emdneto / name: Emídio Neto (07fba9e, 860cb41, 9f6d9b0, f52f676)

xrmx

Thanks for the PR, I think you are missing one piece of the puzzle that is to test both the implementation and not just one.
In short you have to split the test-requirements.txt in one for cassandra-driver and the other for scylla-driver and update tox.ini accordingly.
The split plus a ton of unrelated changes are available in this PR https://github.com/open-telemetry/opentelemetry-python-contrib/pull/4180/changes

andreamatt

Done — split test requirements into separate files for cassandra-driver and scylla-driver, with separate tox environments for each. Both pass:

py313-test-instrumentation-cassandra-driver: 8/8 passed
py312-test-instrumentation-cassandra-scylla: 8/8 passed

tox.ini

The cassandra instrumentation listed both cassandra-driver and scylla-driver in _instruments, which requires ALL listed packages to be installed. Since users install one OR the other (they are alternative drivers for the same API), this should use _instruments_any so that having either driver installed is sufficient. This follows the same pattern already used by psycopg2 and kafka-python instrumentations, introduced in open-telemetry#3610. Co-authored-by: Cursor <cursoragent@cursor.com>

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

…/opentelemetry-python-contrib into fix/cassandra-instruments-any

xrmx · 2026-02-12T09:00:58Z

Opened a PR for updating the pending checks with the renamed ones, need that to be merged before we can merge this.

xrmx · 2026-02-13T09:33:53Z

Uhm the terraform definition looks like this:

      { context = "instrumentation-cassandra-driver" },
      { context = "instrumentation-cassandra-driver 3.10 Ubuntu" },
      { context = "instrumentation-cassandra-driver 3.11 Ubuntu" },
      { context = "instrumentation-cassandra-driver 3.12 Ubuntu" },
      { context = "instrumentation-cassandra-driver 3.9 Ubuntu" },
      { context = "instrumentation-cassandra-scylla" },
      { context = "instrumentation-cassandra-scylla 3.10 Ubuntu" },
      { context = "instrumentation-cassandra-scylla 3.11 Ubuntu" },
      { context = "instrumentation-cassandra-scylla 3.12 Ubuntu" },
      { context = "instrumentation-cassandra-scylla 3.9 Ubuntu" },
...
      { context = "instrumentation-confluent-kafka" },
      { context = "instrumentation-confluent-kafka 3.10 Ubuntu" },
      { context = "instrumentation-confluent-kafka 3.11 Ubuntu" },
      { context = "instrumentation-confluent-kafka 3.12 Ubuntu" },
      { context = "instrumentation-confluent-kafka 3.9 Ubuntu" },

But the for some reasons the two contexts not referring to a specific tox environment are not found for this instrumentation but they are found for the other instrumentations 😓

xrmx · 2026-02-13T11:19:00Z

The names without the python version are the lint ones and the one for the cassandra instrumentation is called instrumentation-cassandra

…ps (open-telemetry#4182) * cassandra: use _instruments_any instead of _instruments for driver deps The cassandra instrumentation listed both cassandra-driver and scylla-driver in _instruments, which requires ALL listed packages to be installed. Since users install one OR the other (they are alternative drivers for the same API), this should use _instruments_any so that having either driver installed is sufficient. This follows the same pattern already used by psycopg2 and kafka-python instrumentations, introduced in open-telemetry#3610. Co-authored-by: Cursor <cursoragent@cursor.com> * fix ci Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com> * fix uv.lock Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com> --------- Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com> Co-authored-by: Cursor <cursoragent@cursor.com> Co-authored-by: emdneto <9735060+emdneto@users.noreply.github.com>

andreamatt force-pushed the fix/cassandra-instruments-any branch from fdcc855 to b27f1e3 Compare February 9, 2026 16:41

andreamatt marked this pull request as ready for review February 9, 2026 16:51

andreamatt requested a review from a team as a code owner February 9, 2026 16:51

andreamatt marked this pull request as draft February 9, 2026 16:54

andreamatt force-pushed the fix/cassandra-instruments-any branch 2 times, most recently from 935feab to f96edf4 Compare February 9, 2026 17:02

andreamatt marked this pull request as ready for review February 10, 2026 08:44

xrmx mentioned this pull request Feb 10, 2026

requirements: stick with older setuptools for packages still using pkg_resources #4180

Closed

11 tasks

xrmx reviewed Feb 10, 2026

View reviewed changes

andreamatt force-pushed the fix/cassandra-instruments-any branch from f96edf4 to 51d855b Compare February 10, 2026 17:11

andreamatt commented Feb 10, 2026

View reviewed changes

andreamatt force-pushed the fix/cassandra-instruments-any branch from 51d855b to 7ba9c50 Compare February 10, 2026 19:05

xrmx reviewed Feb 11, 2026

View reviewed changes

tox.ini Outdated Show resolved Hide resolved

xrmx reviewed Feb 11, 2026

View reviewed changes

tox.ini Outdated Show resolved Hide resolved

andreamatt force-pushed the fix/cassandra-instruments-any branch from 7ba9c50 to de3f0f8 Compare February 11, 2026 10:01

emdneto added 4 commits February 11, 2026 18:19

fix ci

f52f676

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

Merge branch 'main' into fix/cassandra-instruments-any

9f6d9b0

fix uv.lock

07fba9e

Signed-off-by: emdneto <9735060+emdneto@users.noreply.github.com>

Merge branch 'fix/cassandra-instruments-any' of github.com:andreamatt…

860cb41

…/opentelemetry-python-contrib into fix/cassandra-instruments-any

emdneto approved these changes Feb 11, 2026

View reviewed changes

xrmx approved these changes Feb 12, 2026

View reviewed changes

xrmx added this to Python PR digest Feb 12, 2026

xrmx moved this to Approved PRs that need fixes in Python PR digest Feb 12, 2026

xrmx removed the status in Python PR digest Feb 12, 2026

xrmx moved this to Approved PRs in Python PR digest Feb 12, 2026

xrmx merged commit d5aebef into open-telemetry:main Feb 13, 2026
668 checks passed

github-project-automation bot moved this from Approved PRs to Done in Python PR digest Feb 13, 2026

Cirilla-zmh mentioned this pull request Mar 5, 2026

chore: sync upstream/main into main alibaba/loongsuite-python-agent#125

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

cassandra: use _instruments_any instead of _instruments for driver deps#4182

cassandra: use _instruments_any instead of _instruments for driver deps#4182
xrmx merged 5 commits intoopen-telemetry:mainfrom
andreamatt:fix/cassandra-instruments-any

andreamatt commented Feb 9, 2026 •

edited

Loading

Uh oh!

linux-foundation-easycla bot commented Feb 9, 2026 •

edited

Loading

Uh oh!

xrmx left a comment

Uh oh!

andreamatt left a comment

Uh oh!

Uh oh!

Uh oh!

xrmx commented Feb 12, 2026

Uh oh!

xrmx commented Feb 13, 2026 •

edited

Loading

Uh oh!

xrmx commented Feb 13, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

andreamatt commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of change

How Has This Been Tested?

Does This PR Require a Core Repo Change?

Checklist:

Uh oh!

linux-foundation-easycla bot commented Feb 9, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xrmx left a comment

Choose a reason for hiding this comment

Uh oh!

andreamatt left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

xrmx commented Feb 12, 2026

Uh oh!

xrmx commented Feb 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

xrmx commented Feb 13, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

andreamatt commented Feb 9, 2026 •

edited

Loading

linux-foundation-easycla bot commented Feb 9, 2026 •

edited

Loading

xrmx commented Feb 13, 2026 •

edited

Loading