HTTP spans are duplicated if auto-instumentation in OpenTelemetry is enabled

[lmolkova]

• Package Name: azure-core-tracing-opentelemetry
• Package Version: any
• Operating System: any
• Python Version: any

Describe the bug
Http spans are tracked by Azure SDK and OTel auto-collector

To Reproduce

1. configure opentelemtry to auto-trace http requests

pip install opentelemetry-instrumentation-requests

from opentelemetry.instrumentation.requests import RequestsInstrumentor
RequestsInstrumentor().instrument()

2. export spans (anywhere, e.g. console)
3. follow example, e.g. one in pypi
4. http spans are duplicated

{
    "name": "HTTP PUT",
    "context": {
        "trace_id": "0x1d964fb974568d75d5a6b37c6fd5fd72",
        "span_id": "0x35d7dc26f4d2a3d9",
        "trace_state": "[]"
    },
    "kind": "SpanKind.CLIENT",
    "parent_id": "0x779d7555486ca027",
    "start_time": "2021-06-29T18:12:59.427323Z",
    "end_time": "2021-06-29T18:12:59.514322Z",
    "status": {
        "status_code": "UNSET"
    },
    "attributes": {
        "http.method": "PUT",
        "http.url": "https://azmondemo.blob.core.windows.net/mycontainer1?restype=container",
        "http.status_code": 201
    },
    "events": [],
    "links": [],
    "resource": {
        "telemetry.sdk.language": "python",
        "telemetry.sdk.name": "opentelemetry",
        "telemetry.sdk.version": "1.3.0",
        "service.name": "unknown_service"
    }
}
{
    "name": "/mycontainer1",
    "context": {
        "trace_id": "0x1d964fb974568d75d5a6b37c6fd5fd72",
        "span_id": "0x90f15d7360c527e3",
        "trace_state": "[]"
    },
    "kind": "SpanKind.CLIENT",
    "parent_id": "0x779d7555486ca027",
    "start_time": "2021-06-29T18:12:59.427323Z",
    "end_time": "2021-06-29T18:12:59.516327Z",
    "status": {
        "status_code": "UNSET"
    },
    "attributes": {
        "component": "http",
        "http.method": "PUT",
        "http.url": "https://azmondemo.blob.core.windows.net/mycontainer1?restype=container",
        "http.user_agent": "azsdk-python-storage-blob/12.8.1 Python/3.9.6 (Windows-10-10.0.19043-SP0)",
        "http.status_code": 201,
        "x-ms-client-request-id": "a2cbd4bf-d905-11eb-84d4-d03c1f05e55a",
        "x-ms-request-id": "1f663372-a01e-008d-1712-6d460f000000"
    },
    "events": [],
    "links": [],
    "resource": {
        "telemetry.sdk.language": "python",
        "telemetry.sdk.name": "opentelemetry",
        "telemetry.sdk.version": "1.3.0",
        "service.name": "unknown_service"
    }
}

Expected behavior
Only one HTTP span is tracked

Solution
[Update]: does not currently work: below solution requires taking a dependency on opentelemetry-instrumentation.

Please put the suppress_instrumentation key on the context to suppress auto-instrumentation when creating HTTP span here.
Value should be true. Please investigate if false needs to be populated after http span ends (i.e. if context leaks to other requests).

Additional context
Please try to repro and make sure it's fixed.
More context: open-telemetry/opentelemetry-specification#1767

Full example:

pip install opentelemetry-instrumentation-requests

# Declare OpenTelemetry as enabled tracing plugin for Azure SDKs
from azure.core.settings import settings
from azure.core.tracing.ext.opentelemetry_span import OpenTelemetrySpan

settings.tracing_implementation = OpenTelemetrySpan


# Regular open telemetry usage from here, see https://github.com/open-telemetry/opentelemetry-python
# for details
from opentelemetry import trace
from opentelemetry.sdk.trace import TracerProvider
from opentelemetry.sdk.trace.export import ConsoleSpanExporter
from opentelemetry.sdk.trace.export import SimpleSpanProcessor
from opentelemetry.instrumentation.requests import RequestsInstrumentor
RequestsInstrumentor().instrument()


# Simple console exporter
exporter = ConsoleSpanExporter()

trace.set_tracer_provider(TracerProvider())
tracer = trace.get_tracer(__name__)
trace.get_tracer_provider().add_span_processor(
    SimpleSpanProcessor(exporter)
)

# Example with Storage SDKs

from azure.storage.blob import BlobServiceClient

with tracer.start_as_current_span(name="MyApplication"):
    client = BlobServiceClient.from_connection_string('secret')
    client.create_container('mycontainer1')  # Call will be traced

[lmolkova]

This is a cross-language problem, I'm looking for a generic solution, nothing can be done for now