modify docs

open-telemetry · Oct 9, 2023 · 3adc0cd · 3adc0cd
1 parent d342d8c
commit 3adc0cd
Show file tree

Hide file tree

Showing 2 changed files with 16 additions and 16 deletions.
diff --git a/instrumentation/opentelemetry-instrumentation-asyncio/README.rst b/instrumentation/opentelemetry-instrumentation-asyncio/README.rst
@@ -19,19 +19,19 @@ Set the name of the coroutine you want to trace.
     export OTEL_PYTHON_ASYNCIO_COROUTINE_NAMES_TO_TRACE=coro_name,coro_name2,coro_name3
 
 If you want to keep track of which function to use in the to_thread function of asyncio, set the name of the function.
-----
+-----------------------------------------------
 .. code::
     export OTEL_PYTHON_ASYNCIO_TO_THREAD_FUNCTION_NAMES_TO_TRACE=func_name,func_name2,func_name3
 
 For future, set it up like this
-----
+-----------------------------------------------
 .. code::
     export OTEL_PYTHON_ASYNCIO_FUTURE_TRACE_ENABLED=true
 
-Run instrumented taskcoroutine
-----
+Run instrumented application
+--------------------
 1. coroutine
-----
+--------------------
 .. code:: python
 
     # export OTEL_PYTHON_ASYNCIO_COROUTINE_NAMES_TO_TRACE=sleep
@@ -47,7 +47,7 @@ Run instrumented taskcoroutine
     asyncio.run(main())
 
 2. future
-----
+--------------------
 .. code:: python
 
     # export OTEL_PYTHON_ASYNCIO_FUTURE_TRACE_ENABLED=true
@@ -60,7 +60,7 @@ Run instrumented taskcoroutine
     loop.run_until_complete(task)
 
 3. to_thread
-----
+--------------------
 .. code:: python
 
     # export OTEL_PYTHON_ASYNCIO_TO_THREAD_FUNCTION_NAMES_TO_TRACE=func
@@ -80,7 +80,7 @@ Run instrumented taskcoroutine
 
 
 asyncio metric types
--------
+--------------------
 
 * `asyncio.futures.duration` (ms) - Duration of the future
 * `asyncio.futures.exceptions` (count) - Number of exceptions raised by the future

diff --git a/...entelemetry-instrumentation-asyncio/src/opentelemetry/instrumentation/asyncio/__init__.py b/...entelemetry-instrumentation-asyncio/src/opentelemetry/instrumentation/asyncio/__init__.py
@@ -24,19 +24,19 @@
     export OTEL_PYTHON_ASYNCIO_COROUTINE_NAMES_TO_TRACE=coro_name,coro_name2,coro_name3
 
 If you want to keep track of which function to use in the to_thread function of asyncio, set the name of the function.
-----
+-----------------------------------------------
 .. code::
     export OTEL_PYTHON_ASYNCIO_TO_THREAD_FUNCTION_NAMES_TO_TRACE=func_name,func_name2,func_name3
 
 For future, set it up like this
-----
+-----------------------------------------------
 .. code::
     export OTEL_PYTHON_ASYNCIO_FUTURE_TRACE_ENABLED=true
 
-Run instrumented taskcoroutine
-----
+Run instrumented application
+-----------------------------------------------
 1. coroutine
-----
+-----------------------------------------------
 .. code:: python
 
     # export OTEL_PYTHON_ASYNCIO_COROUTINE_NAMES_TO_TRACE=sleep
@@ -52,7 +52,7 @@ async def main():
     asyncio.run(main())
 
 2. future
-----
+-----------------------------------------------
 .. code:: python
 
     # export OTEL_PYTHON_ASYNCIO_FUTURE_TRACE_ENABLED=true
@@ -65,7 +65,7 @@ async def main():
     loop.run_until_complete(task)
 
 3. to_thread
-----
+-----------------------------------------------
 .. code:: python
 
     # export OTEL_PYTHON_ASYNCIO_TO_THREAD_FUNCTION_NAMES_TO_TRACE=func
@@ -85,7 +85,7 @@ def func():
 
 
 asyncio metric types
--------
+-----------------------------------------------
 
 * `asyncio.futures.duration` (ms) - Duration of the future
 * `asyncio.futures.exceptions` (count) - Number of exceptions raised by the future