Skip to content

Commit d73b88f

Browse files
committed
Rename RequestsInstrumentation to RequestsInstrumentor to follow conventions
1 parent 315b438 commit d73b88f

File tree

5 files changed

+24
-21
lines changed

5 files changed

+24
-21
lines changed

instrumentation/opentelemetry-instrumentation-pika/README.rst

+4-4
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,13 @@ Usage
3030
.. code-block:: python
3131
3232
import pika
33-
from opentelemetry.instrumentation.pika import PikaInstrumentation
33+
from opentelemetry.instrumentation.pika import PikaInstrumentor
3434
3535
connection = pika.BlockingConnection(pika.URLParameters('amqp://localhost'))
3636
channel = connection.channel()
3737
channel.queue_declare(queue='hello')
3838
39-
pika_instrumentation = PikaInstrumentation()
39+
pika_instrumentation = PikaInstrumentor()
4040
pika_instrumentation.instrument(channel=channel)
4141
4242
@@ -45,11 +45,11 @@ Usage
4545
pika_instrumentation.uninstrument(channel=channel)
4646
4747
48-
* PikaInstrumentation also supports instrumentation without creating an object, and receiving a tracer_provider
48+
* PikaInstrumentor also supports instrumentation without creating an object, and receiving a tracer_provider
4949

5050
.. code-block:: python
5151
52-
PikaInstrumentation.instrument_channel(channel, tracer_provider=tracer_provider)
52+
PikaInstrumentor.instrument_channel(channel, tracer_provider=tracer_provider)
5353
5454
References
5555
----------

instrumentation/opentelemetry-instrumentation-pika/setup.cfg

+3
Original file line numberDiff line numberDiff line change
@@ -50,3 +50,6 @@ test =
5050
[options.packages.find]
5151
where = src
5252

53+
[options.entry_points]
54+
opentelemetry_instrumentor =
55+
pika = opentelemetry.instrumentation.pika:PikaInstrumentor

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

+5-5
Original file line numberDiff line numberDiff line change
@@ -29,13 +29,13 @@
2929
.. code-block:: python
3030
3131
import pika
32-
from opentelemetry.instrumentation.pika import PikaInstrumentation
32+
from opentelemetry.instrumentation.pika import PikaInstrumentor
3333
3434
connection = pika.BlockingConnection(pika.URLParameters('amqp://localhost'))
3535
channel = connection.channel()
3636
channel.queue_declare(queue='hello')
3737
38-
pika_instrumentation = PikaInstrumentation()
38+
pika_instrumentation = PikaInstrumentor()
3939
pika_instrumentation.instrument(channel=channel)
4040
4141
@@ -44,16 +44,16 @@
4444
pika_instrumentation.uninstrument(channel=channel)
4545
4646
47-
* PikaInstrumentation also supports instrumentation without creating an object, and receiving a tracer_provider
47+
* PikaInstrumentor also supports instrumentation without creating an object, and receiving a tracer_provider
4848
4949
.. code-block:: python
5050
51-
PikaInstrumentation.instrument_channel(channel, tracer_provider=tracer_provider)
51+
PikaInstrumentor.instrument_channel(channel, tracer_provider=tracer_provider)
5252
5353
API
5454
---
5555
"""
5656

5757

58-
from .pika_instrumentor import PikaInstrumentation
58+
from .pika_instrumentor import PikaInstrumentor
5959
from .version import __version__

instrumentation/opentelemetry-instrumentation-pika/src/opentelemetry/instrumentation/pika/pika_instrumentor.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
FUNCTIONS_TO_UNINSTRUMENT = ["basic_publish"]
3030

3131

32-
class PikaInstrumentation(BaseInstrumentor): # type: ignore
32+
class PikaInstrumentor(BaseInstrumentor): # type: ignore
3333
@staticmethod
3434
def _instrument_consumers(
3535
consumers_dict: Dict[str, Callable[..., Any]], tracer: Tracer
@@ -54,7 +54,7 @@ def _instrument_channel_functions(
5454
channel: Channel, tracer: Tracer
5555
) -> None:
5656
if hasattr(channel, "basic_publish"):
57-
PikaInstrumentation._instrument_basic_publish(channel, tracer)
57+
PikaInstrumentor._instrument_basic_publish(channel, tracer)
5858

5959
@staticmethod
6060
def _uninstrument_channel_functions(channel: Channel) -> None:
@@ -75,17 +75,17 @@ def instrument_channel(
7575
tracer = trace.get_tracer(__name__, __version__, tracer_provider)
7676
channel.__setattr__("__opentelemetry_tracer", tracer)
7777
if channel._impl._consumers:
78-
PikaInstrumentation._instrument_consumers(
78+
PikaInstrumentor._instrument_consumers(
7979
channel._impl._consumers, tracer
8080
)
81-
PikaInstrumentation._instrument_channel_functions(channel, tracer)
81+
PikaInstrumentor._instrument_channel_functions(channel, tracer)
8282

8383
def _instrument(self, **kwargs: Dict[str, Any]) -> None:
8484
channel: Channel = kwargs.get("channel", None)
8585
if not channel or not isinstance(channel, Channel):
8686
return
8787
tracer_provider: TracerProvider = kwargs.get("tracer_provider", None)
88-
PikaInstrumentation.instrument_channel(
88+
PikaInstrumentor.instrument_channel(
8989
channel, tracer_provider=tracer_provider
9090
)
9191

@@ -99,7 +99,7 @@ def _uninstrument(self, **kwargs: Dict[str, Any]) -> None:
9999
for key, callback in channel._impl._consumers.items():
100100
if hasattr(callback, "_original_callback"):
101101
channel._impl._consumers[key] = callback._original_callback
102-
PikaInstrumentation._uninstrument_channel_functions(channel)
102+
PikaInstrumentor._uninstrument_channel_functions(channel)
103103

104104
def instrumentation_dependencies(self) -> Collection[str]:
105105
return _instruments

instrumentation/opentelemetry-instrumentation-pika/tests/test_pika_instrumentation.py

+6-6
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
from pika.adapters import BaseConnection
1717
from pika.channel import Channel
1818

19-
from opentelemetry.instrumentation.pika import PikaInstrumentation
19+
from opentelemetry.instrumentation.pika import PikaInstrumentor
2020
from opentelemetry.trace import Tracer
2121

2222

@@ -38,7 +38,7 @@ def test_instrument_api(
3838
uninstrument_channel_functions: mock.MagicMock,
3939
instrument_channel: mock.MagicMock,
4040
) -> None:
41-
instrumentation = PikaInstrumentation()
41+
instrumentation = PikaInstrumentor()
4242
instrumentation.instrument(channel=self.channel)
4343
instrument_channel.assert_called_once_with(
4444
self.channel, tracer_provider=None
@@ -64,7 +64,7 @@ def test_instrument(
6464
instrument_consumers: mock.MagicMock,
6565
instrument_channel_functions: mock.MagicMock,
6666
):
67-
PikaInstrumentation.instrument_channel(channel=self.channel)
67+
PikaInstrumentor.instrument_channel(channel=self.channel)
6868
assert hasattr(
6969
self.channel, "__opentelemetry_tracer"
7070
), "Tracer not set for the channel!"
@@ -80,7 +80,7 @@ def test_instrument_consumers(
8080
mock.call(value, tracer, key)
8181
for key, value in self.channel._impl._consumers.items()
8282
]
83-
PikaInstrumentation._instrument_consumers(
83+
PikaInstrumentor._instrument_consumers(
8484
self.channel._impl._consumers, tracer
8585
)
8686
decorate_callback.assert_has_calls(
@@ -99,7 +99,7 @@ def test_instrument_basic_publish(
9999
) -> None:
100100
tracer = mock.MagicMock(spec=Tracer)
101101
original_function = self.channel.basic_publish
102-
PikaInstrumentation._instrument_basic_publish(self.channel, tracer)
102+
PikaInstrumentor._instrument_basic_publish(self.channel, tracer)
103103
decorate_basic_publish.assert_called_once_with(
104104
original_function, self.channel, tracer
105105
)
@@ -114,5 +114,5 @@ def test_uninstrument_channel_functions(self) -> None:
114114
original_function = self.channel.basic_publish
115115
self.channel.basic_publish = mock.MagicMock()
116116
self.channel.basic_publish._original_function = original_function
117-
PikaInstrumentation._uninstrument_channel_functions(self.channel)
117+
PikaInstrumentor._uninstrument_channel_functions(self.channel)
118118
self.assertEqual(self.channel.basic_publish, original_function)

0 commit comments

Comments
 (0)