Merge branch 'main' into fix-batchlogprocessor-gc

Author: aabmass

CHANGELOG.md

@@ -19,6 +19,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   ([#4498](https://github.com/open-telemetry/opentelemetry-python/pull/4498))
 - Patch logging.basicConfig so OTel logs don't cause console logs to disappear
   ([#4436](https://github.com/open-telemetry/opentelemetry-python/pull/4436))
+- Bump semantic conventions to 1.32.0
+  ([#4530](https://github.com/open-telemetry/opentelemetry-python/pull/4530))
 - Fix ExplicitBucketHistogramAggregation to handle multiple explicit bucket boundaries advisories
   ([#4521](https://github.com/open-telemetry/opentelemetry-python/pull/4521))
 - opentelemetry-sdk: Fix serialization of objects in log handler

exporter/opentelemetry-exporter-otlp-proto-common/src/opentelemetry/exporter/otlp/proto/common/_internal/metrics_encoder/__init__.py

@@ -117,8 +117,9 @@ def _get_temporality(
                 _logger.warning(
                     "Unrecognized OTEL_EXPORTER_METRICS_TEMPORALITY_PREFERENCE"
                     " value found: "
-                    f"{otel_exporter_otlp_metrics_temporality_preference}, "
-                    "using CUMULATIVE"
+                    "%s, "
+                    "using CUMULATIVE",
+                    otel_exporter_otlp_metrics_temporality_preference,
                 )
             instrument_class_temporality = {
                 Counter: AggregationTemporality.CUMULATIVE,

exporter/opentelemetry-exporter-otlp-proto-grpc/src/opentelemetry/exporter/otlp/proto/grpc/exporter.py

@@ -125,7 +125,8 @@ def _read_file(file_path: str) -> Optional[bytes]:
             return file.read()
     except FileNotFoundError as e:
         logger.exception(
-            f"Failed to read file: {e.filename}. Please check if the file exists and is accessible."
+            "Failed to read file: %s. Please check if the file exists and is accessible.",
+            e.filename,
         )
         return None
 

opentelemetry-sdk/src/opentelemetry/sdk/error_handler/__init__.py

@@ -130,8 +130,7 @@ def __exit__(self, exc_type, exc_value, traceback):
                 # pylint: disable=broad-exception-caught
                 except Exception as error_handling_error:
                     logger.exception(
-                        "%s error while handling error"
-                        " %s by error handler %s",
+                        "%s error while handling error %s by error handler %s",
                         error_handling_error.__class__.__name__,
                         exc_value.__class__.__name__,
                         error_handler_class.__name__,

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/app_attributes.py

@@ -0,0 +1,37 @@
+# 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.
+
+from typing import Final
+
+APP_INSTALLATION_ID: Final = "app.installation.id"
+"""
+A unique identifier representing the installation of an application on a specific device.
+Note: Its value SHOULD persist across launches of the same application installation, including through application upgrades.
+It SHOULD change if the application is uninstalled or if all applications of the vendor are uninstalled.
+Additionally, users might be able to reset this value (e.g. by clearing application data).
+If an app is installed multiple times on the same device (e.g. in different accounts on Android), each `app.installation.id` SHOULD have a different value.
+If multiple OpenTelemetry SDKs are used within the same application, they SHOULD use the same value for `app.installation.id`.
+Hardware IDs (e.g. serial number, IMEI, MAC address) MUST NOT be used as the `app.installation.id`.
+
+For iOS, this value SHOULD be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/identifierforvendor).
+
+For Android, examples of `app.installation.id` implementations include:
+
+- [Firebase Installation ID](https://firebase.google.com/docs/projects/manage-installations).
+- A globally unique UUID which is persisted across sessions in your application.
+- [App set ID](https://developer.android.com/identity/app-set-id).
+- [`Settings.getString(Settings.Secure.ANDROID_ID)`](https://developer.android.com/reference/android/provider/Settings.Secure#ANDROID_ID).
+
+More information about Android identifier best practices can be found [here](https://developer.android.com/training/articles/user-data-ids).
+"""

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/code_attributes.py

@@ -51,7 +51,7 @@
 * Java method: `com.example.MyHttpService.serveRequest`
 * Java anonymous class method: `com.mycompany.Main$1.myMethod`
 * Java lambda method: `com.mycompany.Main$$Lambda/0x0000748ae4149c00.myMethod`
-* PHP function: `GuzzleHttp\\Client::transfer
+* PHP function: `GuzzleHttp\\Client::transfer`
 * Go function: `github.com/my/repo/pkg.foo.func5`
 * Elixir: `OpenTelemetry.Ctx.new`
 * Erlang: `opentelemetry_ctx:new`

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/cpython_attributes.py

@@ -0,0 +1,30 @@
+# 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.
+
+from enum import Enum
+from typing import Final
+
+CPYTHON_GC_GENERATION: Final = "cpython.gc.generation"
+"""
+Value of the garbage collector collection generation.
+"""
+
+
+class CPythonGCGenerationValues(Enum):
+    GENERATION_0 = 0
+    """Generation 0."""
+    GENERATION_1 = 1
+    """Generation 1."""
+    GENERATION_2 = 2
+    """Generation 2."""

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/db_attributes.py

@@ -212,6 +212,9 @@
 The operation name SHOULD NOT be extracted from `db.query.text`,
 when the database system supports cross-table queries in non-batch operations.
 
+If spaces can occur in the operation name, multiple consecutive spaces
+SHOULD be normalized to a single space.
+
 For batch operations, if the individual operations are known to have the same operation name
 then that operation name SHOULD be used prepended by `BATCH `,
 otherwise `db.operation.name` SHOULD be `BATCH` or some other database
@@ -223,6 +226,7 @@
 A database operation parameter, with `<key>` being the parameter name, and the attribute value being a string representation of the parameter value.
 Note: If a parameter has no name and instead is referenced only by index, then `<key>` SHOULD be the 0-based index.
 If `db.query.text` is also captured, then `db.operation.parameter.<key>` SHOULD match up with the parameterized placeholders present in `db.query.text`.
+`db.operation.parameter.<key>` SHOULD NOT be captured on batch operations.
 """
 
 DB_QUERY_PARAMETER_TEMPLATE: Final = "db.query.parameter"
@@ -264,14 +268,24 @@
 
 DB_SQL_TABLE: Final = "db.sql.table"
 """
-Deprecated: Replaced by `db.collection.name`.
+Deprecated: Replaced by `db.collection.name`, but only if not extracting the value from `db.query.text`.
 """
 
 DB_STATEMENT: Final = "db.statement"
 """
 Deprecated: Replaced by `db.query.text`.
 """
 
+DB_STORED_PROCEDURE_NAME: Final = "db.stored_procedure.name"
+"""
+The name of a stored procedure within the database.
+Note: It is RECOMMENDED to capture the value as provided by the application
+without attempting to do any case normalization.
+
+For batch operations, if the individual operations are known to have the same
+stored procedure name then that stored procedure name SHOULD be used.
+"""
+
 DB_SYSTEM: Final = "db.system"
 """
 Deprecated: Replaced by `db.system.name`.

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/device_attributes.py

@@ -17,7 +17,22 @@
 DEVICE_ID: Final = "device.id"
 """
 A unique identifier representing the device.
-Note: The device identifier MUST only be defined using the values outlined below. This value is not an advertising identifier and MUST NOT be used as such. On iOS (Swift or Objective-C), this value MUST be equal to the [vendor identifier](https://developer.apple.com/documentation/uikit/uidevice/1620059-identifierforvendor). On Android (Java or Kotlin), this value MUST be equal to the Firebase Installation ID or a globally unique UUID which is persisted across sessions in your application. More information can be found [here](https://developer.android.com/training/articles/user-data-ids) on best practices and exact implementation details. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply, ensure you do your own due diligence.
+Note: Its value SHOULD be identical for all apps on a device and it SHOULD NOT change if an app is uninstalled and re-installed.
+However, it might be resettable by the user for all apps on a device.
+Hardware IDs (e.g. vendor-specific serial number, IMEI or MAC address) MAY be used as values.
+
+More information about Android identifier best practices can be found [here](https://developer.android.com/training/articles/user-data-ids).
+
+> [!WARNING]
+>
+> This attribute may contain sensitive (PII) information. Caution should be taken when storing personal data or anything which can identify a user. GDPR and data protection laws may apply,
+> ensure you do your own due diligence.
+>
+> Due to these reasons, this identifier is not recommended for consumer applications and will likely result in rejection from both Google Play and App Store.
+> However, it may be appropriate for specific enterprise scenarios, such as kiosk devices or enterprise-managed devices, with appropriate compliance clearance.
+> Any instrumentation providing this identifier MUST implement it as an opt-in feature.
+>
+> See [`app.installation.id`](/docs/attributes-registry/app.md#app-installation-id) for a more privacy-preserving alternative.
 """
 
 DEVICE_MANUFACTURER: Final = "device.manufacturer"

opentelemetry-semantic-conventions/src/opentelemetry/semconv/_incubating/attributes/error_attributes.py

@@ -17,6 +17,16 @@
 
 from deprecated import deprecated
 
+ERROR_MESSAGE: Final = "error.message"
+"""
+A message providing more detail about an error in human-readable form.
+Note: `error.message` should provide additional context and detail about an error.
+It is NOT RECOMMENDED to duplicate the value of `error.type` in `error.message`.
+It is also NOT RECOMMENDED to duplicate the value of `exception.message` in `error.message`.
+
+`error.message` is NOT RECOMMENDED for metrics or spans due to its unbounded cardinality and overlap with span status.
+"""
+
 ERROR_TYPE: Final = "error.type"
 """
 Deprecated in favor of stable :py:const:`opentelemetry.semconv.attributes.error_attributes.ERROR_TYPE`.