Merge branch 'main' into add_redis_client_only_instrumentation

Author: xrmx

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

@@ -20,20 +20,35 @@
 
 .. code:: python
 
+    import asyncio
     from opentelemetry.instrumentation.aiokafka import AIOKafkaInstrumentor
     from aiokafka import AIOKafkaProducer, AIOKafkaConsumer
 
     # Instrument kafka
     AIOKafkaInstrumentor().instrument()
 
     # report a span of type producer with the default settings
-    producer = AIOKafkaProducer(bootstrap_servers=['localhost:9092'])
-    await producer.send('my-topic', b'raw_bytes')
+    async def produce():
+        producer = AIOKafkaProducer(bootstrap_servers=['localhost:9092'])
+        await producer.start()
+        try:
+            await producer.send_and_wait('my-topic', b'raw_bytes')
+        finally:
+            await producer.stop()
 
     # report a span of type consumer with the default settings
-    consumer = AIOKafkaConsumer('my-topic', group_id='my-group', bootstrap_servers=['localhost:9092'])
-    async for message in consumer:
-    # process message
+    async def consume():
+        consumer = AIOKafkaConsumer('my-topic', group_id='my-group', bootstrap_servers=['localhost:9092'])
+        await consumer.start()
+        try:
+            async for message in consumer:
+                # process message
+                print(message)
+        finally:
+            await consumer.stop()
+
+    asyncio.run(produce())
+    asyncio.run(consume())
 
 The _instrument() method accepts the following keyword args:
 tracer_provider (TracerProvider) - an optional tracer provider
@@ -47,12 +62,14 @@ def async_consume_hook(span: Span, record: kafka.record.ABCRecord, args, kwargs)
 
 .. code:: python
 
-    from opentelemetry.instrumentation.kafka import AIOKafkaInstrumentor
+    import asyncio
+    from opentelemetry.instrumentation.aiokafka import AIOKafkaInstrumentor
     from aiokafka import AIOKafkaProducer, AIOKafkaConsumer
 
     async def async_produce_hook(span, args, kwargs):
         if span and span.is_recording():
             span.set_attribute("custom_user_attribute_from_async_response_hook", "some-value")
+
     async def async_consume_hook(span, record, args, kwargs):
         if span and span.is_recording():
             span.set_attribute("custom_user_attribute_from_consume_hook", "some-value")
@@ -62,8 +79,15 @@ async def async_consume_hook(span, record, args, kwargs):
 
     # Using kafka as normal now will automatically generate spans,
     # including user custom attributes added from the hooks
-    producer = AIOKafkaProducer(bootstrap_servers=['localhost:9092'])
-    await producer.send('my-topic', b'raw_bytes')
+    async def produce():
+        producer = AIOKafkaProducer(bootstrap_servers=['localhost:9092'])
+        await producer.start()
+        try:
+            await producer.send_and_wait('my-topic', b'raw_bytes')
+        finally:
+            await producer.stop()
+
+    asyncio.run(produce())
 
 API
 ___

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

@@ -26,12 +26,12 @@
     import MySQLdb
     from opentelemetry.instrumentation.mysqlclient import MySQLClientInstrumentor
 
-
     MySQLClientInstrumentor().instrument()
 
     cnx = MySQLdb.connect(database="MySQL_Database")
     cursor = cnx.cursor()
-    cursor.execute("INSERT INTO test (testField) VALUES (123)"
+    cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)")
+    cursor.execute("INSERT INTO test (testField) VALUES (123)")
     cnx.commit()
     cursor.close()
     cnx.close()
@@ -52,7 +52,7 @@
     cnx = MySQLdb.connect(database="MySQL_Database")
     cursor = cnx.cursor()
     cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)")
-    cursor.execute("INSERT INTO test (testField) VALUES (123)"
+    cursor.execute("INSERT INTO test (testField) VALUES (123)")
     cnx.commit()
     cursor.close()
     cnx.close()
@@ -75,7 +75,7 @@
     )
     cursor = instrumented_cnx.cursor()
     cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)")
-    cursor.execute("INSERT INTO test (testField) VALUES (123)"
+    cursor.execute("INSERT INTO test (testField) VALUES (123)")
     instrumented_cnx.commit()
     cursor.close()
     instrumented_cnx.close()

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

@@ -30,7 +30,8 @@
 
     cnx = pymssql.connect(database="MSSQL_Database")
     cursor = cnx.cursor()
-    cursor.execute("INSERT INTO test (testField) VALUES (123)"
+    cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)")
+    cursor.execute("INSERT INTO test (testField) VALUES (123)")
     cnx.commit()
     cursor.close()
     cnx.close()
@@ -44,7 +45,8 @@
     cnx = pymssql.connect(database="MSSQL_Database")
     instrumented_cnx = PyMSSQLInstrumentor().instrument_connection(cnx)
     cursor = instrumented_cnx.cursor()
-    cursor.execute("INSERT INTO test (testField) VALUES (123)"
+    cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)")
+    cursor.execute("INSERT INTO test (testField) VALUES (123)")
     instrumented_cnx.commit()
     cursor.close()
     instrumented_cnx.close()

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

@@ -31,12 +31,12 @@
 
     cnx = pymysql.connect(database="MySQL_Database")
     cursor = cnx.cursor()
-    cursor.execute("INSERT INTO test (testField) VALUES (123)"
+    cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)")
+    cursor.execute("INSERT INTO test (testField) VALUES (123)")
     cnx.commit()
     cursor.close()
     cnx.close()
 
-
 .. code:: python
 
     import pymysql
@@ -53,7 +53,8 @@
         }
     )
     cursor = instrumented_cnx.cursor()
-    cursor.execute("INSERT INTO test (testField) VALUES (123)"
+    cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)")
+    cursor.execute("INSERT INTO test (testField) VALUES (123)")
     instrumented_cnx.commit()
     cursor.close()
     instrumented_cnx.close()
@@ -75,12 +76,12 @@
 
     cnx = pymysql.connect(database="MySQL_Database")
     cursor = cnx.cursor()
-    cursor.execute("INSERT INTO test (testField) VALUES (123)"
+    cursor.execute("CREATE TABLE IF NOT EXISTS test (testField INTEGER)")
+    cursor.execute("INSERT INTO test (testField) VALUES (123)")
     cnx.commit()
     cursor.close()
     cnx.close()
 
-
 For example,
 ::