Include more request configuration options into the span attributes for the Google GenAI SDK instrumentation (#3374)

* Create a utility to simplify recording request attributes.

* Update recording mechanism to record more request options.

* Improve the recording of span request attributes.

* Reformat with ruff.

* Update TODOs to reflect change made here.

* Update changelog now that PR has been created and can be referenced.

* Fix lint issues.

* Reformat with ruff.

* Add more documentation comments requested in the pull request.

* Add tests and comments that provide some additional clarity regarding the flattening logic in response to PR comments.

* Add tests and comments that provide some additional clarity regarding the flattening logic in response to PR comments.

* Handle corner case where flatten function returns compound output.

* Update prefix to match currently proposed SemConv.

* Update to specify attributes from SemConv constants per PR feedback.

* Use an allowlist for dynamic keys per PR feedback.

* Reformat with ruff.

* Fix lint issues.

* Reformat with ruff.

* Handle flattening errors more gracefully.

* Add support for more wildcards in the allowlist.

* Add a clearer type for the flatten functions.

* Simplify 'exclude_keys' initialization per PR feedback.

* Simplify AllowList constructor type annotation per PR feedback.

* Reformat with ruff.

* Resolve lint error concerning too many returns.

* Reformat with ruff.

* Update name to reflect requested changes in Semantic Conventions pull request #2125.

* Add test to verify correct handling of Unicode.

* Reformat with ruff.

* Remove deuplicated test.

Author: michaelsafyan

instrumentation-genai/opentelemetry-instrumentation-google-genai/CHANGELOG.md

@@ -7,6 +7,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+- Add more request configuration options to the span attributes ([#3374](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3374))
 - Restructure tests to keep in line with repository conventions ([#3344](https://github.com/open-telemetry/opentelemetry-python-contrib/pull/3344))
 
 - Fix [bug](https://github.com/open-telemetry/opentelemetry-python-contrib/issues/3416) where

instrumentation-genai/opentelemetry-instrumentation-google-genai/TODOS.md

@@ -4,7 +4,6 @@
 
 Here are some TODO items required to achieve stability for this package:
 
- - Add more span-level attributes for request configuration
  - Add more span-level attributes for response information
  - Verify and correct formatting of events:
    - Including the 'role' field for message events

instrumentation-genai/opentelemetry-instrumentation-google-genai/pyproject.toml

@@ -37,9 +37,9 @@ classifiers = [
   "Programming Language :: Python :: 3.12"
 ]
 dependencies = [
-  "opentelemetry-api >=1.30.0, <2",
-  "opentelemetry-instrumentation >=0.51b0, <2",
-  "opentelemetry-semantic-conventions >=0.51b0, <2"
+  "opentelemetry-api >=1.31.1, <2",
+  "opentelemetry-instrumentation >=0.52b1, <2",
+  "opentelemetry-semantic-conventions >=0.52b1, <2"
 ]
 
 [project.optional-dependencies]

instrumentation-genai/opentelemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/allowlist_util.py

@@ -0,0 +1,97 @@
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+import os
+import re
+from typing import Iterable, Optional, Set
+
+ALLOWED = True
+DENIED = False
+
+
+def _parse_env_list(s: str) -> Set[str]:
+    result = set()
+    for entry in s.split(","):
+        stripped_entry = entry.strip()
+        if not stripped_entry:
+            continue
+        result.add(stripped_entry)
+    return result
+
+
+class _CompoundMatcher:
+    def __init__(self, entries: Set[str]):
+        self._match_all = "*" in entries
+        self._entries = entries
+        self._regex_matcher = None
+        regex_entries = []
+        for entry in entries:
+            if "*" not in entry:
+                continue
+            if entry == "*":
+                continue
+            entry = entry.replace("[", "\\[")
+            entry = entry.replace("]", "\\]")
+            entry = entry.replace(".", "\\.")
+            entry = entry.replace("*", ".*")
+            regex_entries.append(f"({entry})")
+        if regex_entries:
+            joined_regex = "|".join(regex_entries)
+            regex_str = f"^({joined_regex})$"
+            self._regex_matcher = re.compile(regex_str)
+
+    @property
+    def match_all(self):
+        return self._match_all
+
+    def matches(self, x):
+        if self._match_all:
+            return True
+        if x in self._entries:
+            return True
+        if (self._regex_matcher is not None) and (
+            self._regex_matcher.fullmatch(x)
+        ):
+            return True
+        return False
+
+
+class AllowList:
+    def __init__(
+        self,
+        includes: Optional[Iterable[str]] = None,
+        excludes: Optional[Iterable[str]] = None,
+    ):
+        self._includes = _CompoundMatcher(set(includes or []))
+        self._excludes = _CompoundMatcher(set(excludes or []))
+        assert (not self._includes.match_all) or (
+            not self._excludes.match_all
+        ), "Can't have '*' in both includes and excludes."
+
+    def allowed(self, x: str):
+        if self._excludes.match_all:
+            return self._includes.matches(x)
+        if self._includes.match_all:
+            return not self._excludes.matches(x)
+        return self._includes.matches(x) and not self._excludes.matches(x)
+
+    @staticmethod
+    def from_env(
+        includes_env_var: str, excludes_env_var: Optional[str] = None
+    ):
+        includes = _parse_env_list(os.getenv(includes_env_var) or "")
+        excludes = set()
+        if excludes_env_var:
+            excludes = _parse_env_list(os.getenv(excludes_env_var) or "")
+        return AllowList(includes=includes, excludes=excludes)

instrumentation-genai/opentelemetry-instrumentation-google-genai/src/opentelemetry/instrumentation/google_genai/custom_semconv.py

@@ -0,0 +1,18 @@
+# Copyright The OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+# Semantic Convention still being defined in:
+# https://github.com/open-telemetry/semantic-conventions/pull/2125
+GCP_GENAI_OPERATION_CONFIG = "gcp.gen_ai.operation.config"