Skip to content

Commit 8aa8e75

Browse files
committed
chore: explain what is tracing
1 parent a0a3f42 commit 8aa8e75

File tree

4 files changed

+32
-2
lines changed

4 files changed

+32
-2
lines changed

docs/examples.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,4 +14,3 @@ Examples
1414
examples/pipeline_examples
1515
examples/timeseries_examples
1616
examples/redis-stream-example.ipynb
17-
examples/opentelemetry
Loading
6.25 KB
Loading

docs/opentelemetry.rst

Lines changed: 32 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,29 @@ OpenTelemetry: Monitoring Performance
44
What is OpenTelemetry?
55
----------------------
66

7-
`OpenTelemetry <https://opentelemetry.io>`_ is an open-source observability framework for `distributed 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 <https://uptrace.dev/opentelemetry/distributed-tracing.html>`_, `metrics <https://uptrace.dev/opentelemetry/metrics.html>`_, 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 alternatives <https://uptrace.dev/get/compare/datadog-competitors.html>`_ that support OpenTelemetry.
1010

11+
What is tracing?
12+
----------------
13+
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.
15+
16+
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.
17+
18+
.. image:: images/opentelemetry/distributed-tracing.png
19+
:alt: Trace
20+
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.
22+
23+
**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.
24+
25+
.. image:: images/opentelemetry/tree-of-spans.png
26+
:alt: Trace
27+
28+
To learn more about tracing, see `Distributed Tracing using OpenTelemetry <https://uptrace.dev/opentelemetry/distributed-tracing.html>`_.
29+
1130
OpenTelemetry instrumentation
1231
-----------------------------
1332

@@ -144,3 +163,15 @@ You can also create queries with more complex expressions. For example, the foll
144163
projects: [1]
145164
146165
See `Alerting and Notifications <https://uptrace.dev/get/alerting.html>`_ for details.
166+
167+
What's next?
168+
------------
169+
170+
Next, you can learn how to configure `uptrace-python <https://uptrace.dev/get/uptrace-python.html>`_ to export spans, metrics, and logs to Uptrace.
171+
172+
You may also be interested in the following guides:
173+
174+
- `OpenTelemetry Django <https://uptrace.dev/opentelemetry/instrumentations/python-django.html>`_
175+
- `OpenTelemetry Flask <https://uptrace.dev/opentelemetry/instrumentations/python-flask.html>`_
176+
- `OpenTelemetry FastAPI <https://uptrace.dev/opentelemetry/instrumentations/python-sqlalchemy.html>`_
177+
- `OpenTelemetry instrumentations <http://localhost:8081/opentelemetry/instrumentations/>`_

0 commit comments

Comments
 (0)