Merge branch 'main' into feat/prom-rw-retries

Author: towseef41

instrumentation/opentelemetry-instrumentation-botocore/src/opentelemetry/instrumentation/botocore/__init__.py

@@ -42,20 +42,36 @@
     ec2 = session.create_client("ec2", region_name="us-west-2")
     ec2.describe_instances()
 
+Thread Context Propagation
+--------------------------
+
+boto3's S3 ``upload_file`` and ``download_file`` methods use background threads
+for multipart transfers. To ensure trace context is propagated to these threads,
+also enable the threading instrumentation:
+
+.. code:: python
+
+    from opentelemetry.instrumentation.threading import ThreadingInstrumentor
+    from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
+
+    ThreadingInstrumentor().instrument()
+    BotocoreInstrumentor().instrument()
+
+When using auto-instrumentation (``opentelemetry-instrument``), both instrumentors
+are enabled automatically if their packages are installed.
+
 API
 ---
 
 The `instrument` method accepts the following keyword args:
 
-tracer_provider (TracerProvider) - an optional tracer provider
-request_hook (Callable) - a function with extra user-defined logic to be performed before performing the request
-this function signature is:  def request_hook(span: Span, service_name: str, operation_name: str, api_params: dict) -> None
-response_hook (Callable) - a function with extra user-defined logic to be performed after performing the request
-this function signature is:  def response_hook(span: Span, service_name: str, operation_name: str, result: dict) -> None
+* tracer_provider (``TracerProvider``) - an optional tracer provider
+* request_hook (``Callable[[Span, str, str, dict], None]``) - a function with extra user-defined logic to be performed before performing the request
+* response_hook (``Callable[[Span, str, str, dict], None]``) - a function with extra user-defined logic to be performed after performing the request
 
 for example:
 
-.. code: python
+.. code:: python
 
     from opentelemetry.instrumentation.botocore import BotocoreInstrumentor
     import botocore.session

instrumentation/opentelemetry-instrumentation-pymongo/src/opentelemetry/instrumentation/pymongo/__init__.py

@@ -36,21 +36,15 @@
 ---
 The `instrument` method accepts the following keyword args:
 
-tracer_provider (TracerProvider) - an optional tracer provider
-request_hook (Callable) -
-a function with extra user-defined logic to be performed before querying mongodb
-this function signature is:  def request_hook(span: Span, event: CommandStartedEvent) -> None
-response_hook (Callable) -
-a function with extra user-defined logic to be performed after the query returns with a successful response
-this function signature is:  def response_hook(span: Span, event: CommandSucceededEvent) -> None
-failed_hook (Callable) -
-a function with extra user-defined logic to be performed after the query returns with a failed response
-this function signature is:  def failed_hook(span: Span, event: CommandFailedEvent) -> None
-capture_statement (bool) - an optional value to enable capturing the database statement that is being executed
+* tracer_provider (``TracerProvider``) - an optional tracer provider
+* request_hook (``Callable[[Span, CommandStartedEvent], None]``) - a function with extra user-defined logic to be performed before querying mongodb
+* response_hook (``Callable[[Span, CommandSucceededEvent], None]``) - a function with extra user-defined logic to be performed after the query returns with a successful response
+* failed_hook (``Callable[[Span, CommandFailedEvent], None]``) - a function with extra user-defined logic to be performed after the query returns with a failed response
+* capture_statement (``bool``) - an optional value to enable capturing the database statement that is being executed
 
 for example:
 
-.. code: python
+.. code:: python
 
     from opentelemetry.instrumentation.pymongo import PymongoInstrumentor
     from pymongo import MongoClient

instrumentation/opentelemetry-instrumentation-pymssql/src/opentelemetry/instrumentation/pymssql/__init__.py

@@ -55,11 +55,11 @@
 ---
 The `instrument` method accepts the following keyword args:
 
-tracer_provider (TracerProvider) - an optional tracer provider
+* tracer_provider (``TracerProvider``) - an optional tracer provider
 
 For example:
 
-.. code: python
+.. code:: python
 
     import pymssql
     from opentelemetry.instrumentation.pymssql import PyMSSQLInstrumentor