suppress instrument boto3 XRay.put_trace_segments()

[wangzlei]

Description

I am going to create an AWS XRay exporter in OpenTelemetry-Python, to emit telemetry data to AWS XRay service via boto3 API XRay.put_trace_segments(). This PR is the prerequisite for this in-process exporter.
When I was working on the AWSXrayExporter, the botocore instrumentor would instrument function XRay.put_trace_segments() inside of AWSXrayExporter, causes infinite recursive loop. This PR is inspired from AWS XRay SDK, skip instrument this specific function to avoid infinite recursion.

Fixes # (issue)

Type of change

Please delete options that are not relevant.

• Bug fix (non-breaking change which fixes an issue)

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

• End to end test
  Have created the AWSXrayExporter in local and enable botocore instrumentor in my test App to instrument a boto3 S3.list_buckets function. No infinite recursion problem happen.

• Covered by unit test

Checklist:

• Followed the style guidelines of this project
• Changelogs have been updated
• Unit tests have been added
• Documentation has been updated

[owais]

I think there is an existing mechanism to do exactly this. Have you seen how other exporters solve the same problem? I think they configure the active tracing context to disable tracing and then any instrumented code inside the exporter code-path is not traced. Recommend to look into that and replicate it in the xray exporter.

[owais]

Found it. Examples:

opentelemetry-python/opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py

Line 311 in 97b602f

token = attach(set_value("suppress_instrumentation", True))

opentelemetry-python/opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py

Line 81 in 97b602f

token = attach(set_value("suppress_instrumentation", True))

opentelemetry-python/opentelemetry-sdk/src/opentelemetry/sdk/trace/export/__init__.py

Line 311 in 97b602f

token = attach(set_value("suppress_instrumentation", True))

[NathanielRN]

@owais That's a sweet example, I also found this test which was useful to help me understand how it works:

opentelemetry-python/instrumentation/opentelemetry-instrumentation-requests/tests/test_requests_integration.py

Lines 159 to 169 in 97b602f

	def test_suppress_instrumentation(self):
	token = context.attach(
	context.set_value("suppress_instrumentation", True)
	)
	try:
	result = self.perform_request(self.URL)
	self.assertEqual(result.text, "Hello!")
	finally:
	context.detach(token)
	self.assert_span(num_spans=0)

[wangzlei]

I think there is an existing mechanism to do exactly this. Have you seen how other exporters solve the same problem? I think they configure the active tracing context to disable tracing and then any instrumented code inside the exporter code-path is not traced. Recommend to look into that and replicate it in the xray exporter.

Thanks! now set context suppress_instrumentation to suppress further instrument botocore.

[wangzlei]

@owais Kindly ping that do I miss anything?

[lzchen]

@wangzlei

Can you open up the same pr in the contrib repo?

[wangzlei]

@wangzlei

Can you open up the same pr in the contrib repo?

Yes, will do.