Skip to content

Commit 6d6c1d8

Browse files
committed
chore: cleanup
1 parent 0698978 commit 6d6c1d8

File tree

2 files changed

+9
-8
lines changed

2 files changed

+9
-8
lines changed

docs/examples/opentelemetry_api_examples.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
"id": "861fa9cb",
4848
"metadata": {},
4949
"source": [
50-
"### Create a tracer"
50+
"### Configure OpenTelemetry with console exporter"
5151
]
5252
},
5353
{

docs/opentelemetry.rst

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,21 +4,21 @@ Integrating OpenTelemetry
44
What is OpenTelemetry?
55
----------------------
66

7-
`OpenTelemetry <https://opentelemetry.io>`_ is an open-source observability framework for `traces <https://uptrace.dev/opentelemetry/distributed-tracing.html>`_, `metrics <https://uptrace.dev/opentelemetry/metrics.html>`_, and logs.
7+
`OpenTelemetry <https://opentelemetry.io>`_ is an open-source observability framework for traces, metrics, and logs.
88

99
OpenTelemetry allows developers to collect and export telemetry data in a vendor agnostic way. With OpenTelemetry, you can instrument your application once and then add or change vendors without changing the instrumentation, for example, here is a list of `popular DataDog competitors <https://uptrace.dev/get/compare/datadog-competitors.html>`_ that support OpenTelemetry.
1010

1111
What is tracing?
1212
----------------
1313

14-
`Distributed tracing <https://uptrace.dev/opentelemetry/distributed-tracing.html>`_ allows you to see how a request progresses through different services and systems, timings of each operation, any logs and errors as they occur.
14+
`OpenTelemetry tracing <https://uptrace.dev/opentelemetry/distributed-tracing.html>`_ allows you to see how a request progresses through different services and systems, timings of each operation, any logs and errors as they occur.
1515

1616
In a distributed environment, tracing also helps you understand relationships and interactions between microservices. Distributed tracing gives an insight into how a particular microservice is performing and how that service affects other microservices.
1717

1818
.. image:: images/opentelemetry/distributed-tracing.png
1919
:alt: Trace
2020

21-
Using tracing, you can break down requests into `spans <https://uptrace.dev/opentelemetry/distributed-tracing.html#spans>`_. **Span** is an operation (unit of work) your app performs handling a request, for example, a database query or a network call.
21+
Using tracing, you can break down requests into spans. **Span** is an operation (unit of work) your app performs handling a request, for example, a database query or a network call.
2222

2323
**Trace** is a tree of spans that shows the path that a request makes through an app. Root span is the first span in a trace.
2424

@@ -61,7 +61,7 @@ Once the code is patched, you can use redis-py as usually:
6161
OpenTelemetry API
6262
-----------------
6363

64-
OpenTelemetry API is a programming interface that you can use to instrument code and collect telemetry data such as traces, metrics, and logs.
64+
`OpenTelemetry <https://uptrace.dev/opentelemetry/>`_ API is a programming interface that you can use to instrument code and collect telemetry data such as traces, metrics, and logs.
6565

6666
You can use OpenTelemetry API to measure important operations:
6767

@@ -123,7 +123,7 @@ See introduction to `OpenTelemetry Collector <https://uptrace.dev/opentelemetry/
123123
Alerting and notifications
124124
--------------------------
125125

126-
Uptrace also allows you to monitor metrics using alerting rules. For example, the following rule uses the group by node expression to create an alert whenever an individual Redis shard is down:
126+
Uptrace also allows you to monitor `OpenTelemetry metrics <https://uptrace.dev/opentelemetry/metrics.html>`_ using alerting rules. For example, the following rule uses the group by node expression to create an alert whenever an individual Redis shard is down:
127127

128128
.. code-block:: python
129129
@@ -172,5 +172,6 @@ You may also be interested in the following guides:
172172
173173
- `OpenTelemetry Django <https://uptrace.dev/opentelemetry/instrumentations/python-django.html>`_
174174
- `OpenTelemetry Flask <https://uptrace.dev/opentelemetry/instrumentations/python-flask.html>`_
175-
- `OpenTelemetry FastAPI <https://uptrace.dev/opentelemetry/instrumentations/python-sqlalchemy.html>`_
176-
- `OpenTelemetry instrumentations <http://localhost:8081/opentelemetry/instrumentations/>`_
175+
- `OpenTelemetry FastAPI <https://uptrace.dev/opentelemetry/instrumentations/python-fastapi.html>`_
176+
- `OpenTelemetry SQLAlchemy <https://uptrace.dev/opentelemetry/instrumentations/python-sqlalchemy.html>`_
177+
- `OpenTelemetry instrumentations <https://uptrace.dev/opentelemetry/instrumentations/>`_

0 commit comments

Comments
 (0)