Fix UnknownRemoteOperation for Database instrumentation.

aws-opentelemetry-distro/src/amazon/opentelemetry/distro/_aws_metric_attribute_generator.py

@@ -23,6 +23,7 @@
     get_ingress_operation,
     is_key_present,
     is_local_root,
+    is_valid_db_operation,
     should_generate_dependency_metric_attributes,
     should_generate_service_metric_attributes,
 )
@@ -38,6 +39,7 @@
 # Pertinent OTEL attribute keys
 _SERVICE_NAME: str = ResourceAttributes.SERVICE_NAME
 _DB_OPERATION: str = SpanAttributes.DB_OPERATION
+_DB_STATEMENT: str = SpanAttributes.DB_STATEMENT
 _DB_SYSTEM: str = SpanAttributes.DB_SYSTEM
 _FAAS_INVOKED_NAME: str = SpanAttributes.FAAS_INVOKED_NAME
 _FAAS_TRIGGER: str = SpanAttributes.FAAS_TRIGGER
@@ -208,9 +210,12 @@ def _set_remote_service_and_operation(span: ReadableSpan, attributes: BoundedAtt
     elif is_key_present(span, _RPC_SERVICE) or is_key_present(span, _RPC_METHOD):
         remote_service = _normalize_service_name(span, _get_remote_service(span, _RPC_SERVICE))
         remote_operation = _get_remote_operation(span, _RPC_METHOD)
-    elif is_key_present(span, _DB_SYSTEM) or is_key_present(span, _DB_OPERATION):
+    elif is_key_present(span, _DB_SYSTEM) or is_key_present(span, _DB_OPERATION) or is_key_present(span, _DB_STATEMENT):
         remote_service = _get_remote_service(span, _DB_SYSTEM)
-        remote_operation = _get_remote_operation(span, _DB_OPERATION)
+        if is_key_present(span, _DB_OPERATION):
+            remote_operation = _get_remote_operation(span, _DB_OPERATION)
+        else:
+            remote_operation = _get_db_statement_remote_operation(span, _DB_STATEMENT)
     elif is_key_present(span, _FAAS_INVOKED_NAME) or is_key_present(span, _FAAS_TRIGGER):
         remote_service = _get_remote_service(span, _FAAS_INVOKED_NAME)
         remote_operation = _get_remote_operation(span, _FAAS_TRIGGER)
@@ -251,6 +256,17 @@ def _get_remote_operation(span: ReadableSpan, remote_operation_key: str) -> str:
     return remote_operation
 
 
+def _get_db_statement_remote_operation(span: ReadableSpan, statement_key: str) -> str:
+    remote_operation: str = span.attributes.get(statement_key)
+    if remote_operation is None:
+        remote_operation = UNKNOWN_REMOTE_OPERATION
+
+    operation = remote_operation.split()[0]
+    remote_operation = operation if is_valid_db_operation(operation) else UNKNOWN_REMOTE_OPERATION
+
+    return remote_operation
+
+
 def _normalize_service_name(span: ReadableSpan, service_name: str) -> str:
     """
     TODO: Determine if problems in Java instrumentation are relevant here. Do we need normalization? If so, probably we

aws-opentelemetry-distro/src/amazon/opentelemetry/distro/_aws_span_processing_util.py

@@ -1,6 +1,8 @@
 # Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
 # SPDX-License-Identifier: Apache-2.0
 """Utility module designed to support shared logic across AWS Span Processors."""
+from typing import Set
+
 from amazon.opentelemetry.distro._aws_attribute_keys import AWS_CONSUMER_PARENT_SPAN_KIND, AWS_LOCAL_OPERATION
 from opentelemetry.sdk.trace import InstrumentationScope, ReadableSpan
 from opentelemetry.semconv.trace import MessagingOperationValues, SpanAttributes
@@ -14,6 +16,38 @@
 INTERNAL_OPERATION: str = "InternalOperation"
 LOCAL_ROOT: str = "LOCAL_ROOT"
 
+# The valid remote operation values retrieved from db.statement if no db.operation value is identified
+VALID_DB_OPERATION: Set[str] = {
+    "SELECT",
+    "INSERT",
+    "UPDATE",
+    "DELETE",
+    "CREATE",
+    "DROP",
+    "ALTER",
+    "TRUNCATE",
+    "COPY",
+    "ANALYZE",
+    "VACUUM",
+    "EXPLAIN",
+    "GRANT",
+    "REVOKE",
+    "SET",
+    "BEGIN",
+    "COMMIT",
+    "ROLLBACK",
+    "SAVEPOINT",
+    "LISTEN",
+    "NOTIFY",
+    "DISCARD",
+    "SHOW",
+    "LOCK",
+    "UNLOCK",
+    "REINDEX",
+    "CLUSTER",
+    "COMMENT",
+}
+
 # Useful constants
 _SQS_RECEIVE_MESSAGE_SPAN_NAME: str = "Sqs.ReceiveMessage"
 _AWS_SDK_INSTRUMENTATION_SCOPE_PREFIX: str = "io.opentelemetry.aws-sdk-"
@@ -156,3 +190,7 @@ def _generate_ingress_operation(span: ReadableSpan) -> str:
                     operation = http_method + " " + operation
 
     return operation
+
+
+def is_valid_db_operation(operation: str) -> bool:
+    return operation.upper() in VALID_DB_OPERATION

sample-applications/vehicle-dealership-sample-app/eks/backend-deployment.yaml

@@ -42,6 +42,7 @@ spec:
               value: ${POSTGRES_PASSWORD}
             - name: POSTGRES_USER
               value: djangouser
+#             Setting PYTHONPATH is currently required due to the issue in OTel: open-telemetry/opentelemetry-operator#2302
             - name: PYTHONPATH
               value: "/vehicle-inventory-app"
             - name: DJANGO_SETTINGS_MODULE

sample-applications/vehicle-dealership-sample-app/eks/image-backend-deployment.yaml

@@ -50,6 +50,7 @@ spec:
               value: ${POSTGRES_PASSWORD}
             - name: POSTGRES_USER
               value: djangouser
+#             Setting PYTHONPATH is currently required due to the issue in OTel: open-telemetry/opentelemetry-operator#2302
             - name: PYTHONPATH
               value: "/image-service-app"
             - name: DJANGO_SETTINGS_MODULE