Skip to content

Commit ea0377b

Browse files
committed
update docs
1 parent 5fbf591 commit ea0377b

6 files changed

Lines changed: 11 additions & 11 deletions

File tree

docs/examples/auto-instrumentation/README.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -138,7 +138,7 @@ and run this instead:
138138

139139
.. code:: sh
140140
141-
$ opentelemetry-instrumentation python server_uninstrumented.py
141+
$ opentelemetry-instrument python server_uninstrumented.py
142142
143143
In the console where you previously executed ``client.py``, run again
144144
this again:

docs/examples/datadog_exporter/README.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -66,16 +66,16 @@ Auto-Instrumention Example
6666

6767
.. code-block:: sh
6868
69-
opentelemetry-instrumentation python server.py
69+
opentelemetry-instrument python server.py
7070
7171
* Run client
7272

7373
.. code-block:: sh
7474
75-
opentelemetry-instrumentation python client.py testing
75+
opentelemetry-instrument python client.py testing
7676
7777
* Run client with parameter to raise error
7878

7979
.. code-block:: sh
8080
81-
opentelemetry-instrumentation python client.py error
81+
opentelemetry-instrument python client.py error

ext/opentelemetry-ext-boto/src/opentelemetry/ext/boto/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
Instrument `Boto`_ to trace service requests.
1616
1717
There are two options for instrumenting code. The first option is to use the
18-
``opentelemetry-instrumentation`` executable which will automatically
18+
``opentelemetry-instrument`` executable which will automatically
1919
instrument your Boto client. The second is to programmatically enable
2020
instrumentation via the following code:
2121

ext/opentelemetry-ext-sqlalchemy/src/opentelemetry/ext/sqlalchemy/__init__.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
Instrument `sqlalchemy`_ to report SQL queries.
1717
1818
There are two options for instrumenting code. The first option is to use
19-
the ``opentelemetry-instrumentation`` executable which will automatically
19+
the ``opentelemetry-instrument`` executable which will automatically
2020
instrument your SQLAlchemy engine. The second is to programmatically enable
2121
instrumentation via the following code:
2222

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,12 +16,12 @@
1616
1717
This package provides a couple of commands that help automatically instruments a program:
1818
19-
opentelemetry-instrumentation
19+
opentelemetry-instrument
2020
-----------------------------------
2121
2222
::
2323
24-
opentelemetry-instrumentation python program.py
24+
opentelemetry-instrument python program.py
2525
2626
The code in ``program.py`` needs to use one of the packages for which there is
2727
an OpenTelemetry integration. For a list of the available integrations please

opentelemetry-instrumentation/src/opentelemetry/instrumentation/instrumentor.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ class BaseInstrumentor(ABC):
2828
2929
Child classes of this ABC should instrument specific third
3030
party libraries or frameworks either by using the
31-
``opentelemetry-instrumentation`` command or by calling their methods
31+
``opentelemetry-instrument`` command or by calling their methods
3232
directly.
3333
3434
Since every third party library or framework is different and has different
@@ -58,7 +58,7 @@ def instrument(self, **kwargs):
5858
"""Instrument the library
5959
6060
This method will be called without any optional arguments by the
61-
``opentelemetry-instrumentation`` command. The configuration of
61+
``opentelemetry-instrument`` command. The configuration of
6262
the instrumentation when done in this way should be done by previously
6363
setting the configuration (using environment variables or any other
6464
mechanism) that will be used later by the code in the ``instrument``
@@ -69,7 +69,7 @@ def instrument(self, **kwargs):
6969
7070
This means that calling this method directly without passing any
7171
optional values should do the very same thing that the
72-
``opentelemetry-instrumentation`` command does. This approach is
72+
``opentelemetry-instrument`` command does. This approach is
7373
followed because the ``Configuration`` object is immutable.
7474
"""
7575

0 commit comments

Comments
 (0)