instruments-any and _instruments_any

Author: jeremydvoss

CHANGELOG.md

@@ -30,11 +30,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#3508](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3508))
 - `opentelemetry-instrumentation-pymongo` `aggregate` and `getMore` capture statements support
   ([#3601](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3601))
-- `opentelemetry-instrumentation-fastapi` Utilize instruments_either functionality.
+- `opentelemetry-instrumentation-fastapi` Utilize instruments-any functionality.
   ([#3612](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3612))
-- `opentelemetry-instrumentation-psycopg2` Utilize instruments_either functionality.
+- `opentelemetry-instrumentation-psycopg2` Utilize instruments-any functionality.
   ([#3612](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3612))
-- `opentelemetry-instrumentation-kafka-python` Utilize instruments_either functionality.
+- `opentelemetry-instrumentation-kafka-python` Utilize instruments-any functionality.
   ([#3612](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3612))
 
 ## Version 1.34.0/0.55b0 (2025-06-04)

instrumentation/opentelemetry-instrumentation-fastapi/pyproject.toml

@@ -34,7 +34,7 @@ dependencies = [
 
 [project.optional-dependencies]
 instruments = []
-instruments_either = [
+instruments-any = [
     "fastapi ~= 0.92",
     "fastapi-slim ~= 0.92",
 ]

instrumentation/opentelemetry-instrumentation-fastapi/src/opentelemetry/instrumentation/fastapi/package.py

@@ -15,7 +15,7 @@
 
 # TODO: update this
 _instruments = ()
-_instruments_either = ("fastapi ~= 0.92", "fastapi-slim ~= 0.92")
+_instruments_any = ("fastapi ~= 0.92", "fastapi-slim ~= 0.92")
 
 _supports_metrics = True
 

instrumentation/opentelemetry-instrumentation-kafka-python/pyproject.toml

@@ -32,7 +32,7 @@ dependencies = [
 
 [project.optional-dependencies]
 instruments = []
-instruments_either = [
+instruments-any = [
   "kafka-python >= 2.0, < 3.0",
   "kafka-python-ng >= 2.0, < 3.0"
 ]

instrumentation/opentelemetry-instrumentation-kafka-python/src/opentelemetry/instrumentation/kafka/package.py

@@ -18,4 +18,4 @@
 _instruments_kafka_python_ng = "kafka-python-ng >= 2.0, < 3.0"
 
 _instruments = ()
-_instruments_either = (_instruments_kafka_python, _instruments_kafka_python_ng)
+_instruments_any = (_instruments_kafka_python, _instruments_kafka_python_ng)

instrumentation/opentelemetry-instrumentation-psycopg2/pyproject.toml

@@ -32,7 +32,7 @@ dependencies = [
 
 [project.optional-dependencies]
 instruments = []
-instruments_either = [
+instruments-any = [
   "psycopg2 >= 2.7.3.1",
   "psycopg2-binary >= 2.7.3.1",
 ]

instrumentation/opentelemetry-instrumentation-psycopg2/src/opentelemetry/instrumentation/psycopg2/package.py

@@ -17,9 +17,9 @@
 _instruments_psycopg2 = "psycopg2 >= 2.7.3.1"
 _instruments_psycopg2_binary = "psycopg2-binary >= 2.7.3.1"
 
-# TODO: maybe add _instruments_either
+# TODO: maybe add _instruments_any
 _instruments = ()
-_instruments_either = (
+_instruments_any = (
     _instruments_psycopg2,
     _instruments_psycopg2_binary,
 )

scripts/generate_instrumentation_bootstrap.py

@@ -84,7 +84,7 @@ def main():
         pkg_name = pkg.get("name")
         if pkg_name in packages_to_exclude:
             continue
-        if not pkg["instruments"] and not pkg["instruments_either"]:
+        if not pkg["instruments"] and not pkg["instruments-any"]:
             default_instrumentations.elts.append(ast.Str(pkg["requirement"]))
         for target_pkg in pkg["instruments"]:
             libraries.elts.append(
@@ -93,7 +93,7 @@ def main():
                     values=[ast.Str(target_pkg), ast.Str(pkg["requirement"])],
                 )
             )
-        for target_pkg in pkg["instruments_either"]:
+        for target_pkg in pkg["instruments-any"]:
             libraries.elts.append(
                 ast.Dict(
                     keys=[ast.Str("library"), ast.Str("instrumentation")],

scripts/generate_instrumentation_readme.py

@@ -59,14 +59,14 @@ def main(base_instrumentation_path):
             exec(fh.read(), pkg_info)
 
         instruments_and = pkg_info.get("_instruments", ())
-        instruments_either = pkg_info.get("_instruments_either", ())
+        instruments_any = pkg_info.get("_instruments_any", ())
         supports_metrics = pkg_info.get("_supports_metrics")
         semconv_status = pkg_info.get("_semconv_status")
         instruments_all = ()
-        if not instruments_and and not instruments_either:
+        if not instruments_and and not instruments_any:
             instruments_all = (name,)
         else:
-            instruments_all = tuple(instruments_and + instruments_either)
+            instruments_all = tuple(instruments_and + instruments_any)
 
         if not semconv_status:
             semconv_status = "development"

scripts/otel_packaging.py

@@ -64,14 +64,12 @@ def get_instrumentation_packages(
             "optional-dependencies"
         ]
         instruments = optional_dependencies.get("instruments", [])
-        instruments_either = optional_dependencies.get(
-            "instruments_either", []
-        )
+        instruments_any = optional_dependencies.get("instruments-any", [])
         instrumentation = {
             "name": pyproject_toml["project"]["name"],
             "version": version.strip(),
             "instruments": instruments,
-            "instruments_either": instruments_either,
+            "instruments-any": instruments_any,
         }
         if instrumentation["name"] in independent_packages:
             specifier = independent_packages[instrumentation["name"]]