You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.rst
-10
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,6 @@ OTel enables developers to instrument, generate, collect, and export telemetry d
10
10
The telemetry data can come in the form of traces, metrics, and logs.
11
11
OPEA integrates OpenTelemetry's metrics and tracing capabilities to enhance its telemetry support, providing users with valuable insights into system performance.
12
12
13
-
14
13
How It Works
15
14
************
16
15
OPEA Comps offers telemetry functionalities for metrics and tracing by integrating with tools such as Prometheus, Grafana, and Jaeger. Below is a brief introduction to the workflows of those tools:
@@ -19,8 +18,6 @@ OPEA Comps offers telemetry functionalities for metrics and tracing by integrati
19
18
:width:800
20
19
:alt:Alternative text
21
20
22
-
23
-
24
21
The majority of OPEA's micro and mega services are equipped to support OpenTelemetry metrics, which are exported in Prometheus format via the /metrics endpoint.
25
22
For further guidance, please refer to the section on `Telemetry Metrics <https://github.com/opea-project/GenAIComps/tree/main/comps/cores/telemetry#metrics>`_.
26
23
Prometheus plays a crucial role in collecting metrics from OPEA service endpoints, while Grafana leverages Prometheus as a data source to visualize these metrics on pre-configured dashboards.
@@ -30,7 +27,6 @@ Additionally, HuggingFace's Text Embedding Inference and Text Generation Inferen
30
27
The Jaeger UI monitors trace events from OPEA microservices, TEI, and TGI. Once Jaeger endpoints are configured in OPEA microservices, TEI, and TGI,
31
28
trace data will automatically be reported and visualized in the Jaeger UI.
32
29
33
-
34
30
Deployment
35
31
**********
36
32
@@ -111,7 +107,6 @@ These sections offer insights into how to interpret the data and utilize the das
111
107
ChatQnA <deploy/ChatQnA>
112
108
AgentQnA <deploy/AgentQnA>
113
109
114
-
115
110
3. Jaeger
116
111
+++++++++++++++
117
112
@@ -144,7 +139,6 @@ Select "opea" as the service, then click the "Find Traces" button to view the tr
144
139
:width:400
145
140
:alt:Alternative text
146
141
147
-
148
142
All traces will be displayed on the UI.
149
143
The diagram in the upper right corner provides a visual representation of all requests along the timeline. Meanwhile,
150
144
the diagrams in the lower right corner illustrate all spans within each request, offering detailed insights into the execution flow and timing.
@@ -162,15 +156,13 @@ These sections offer insights into how to interpret the data and utilize the das
162
156
ChatQnA <deploy/ChatQnA>
163
157
AgentQnA <deploy/AgentQnA>
164
158
165
-
166
159
Code Instrumentations for OPEA Tracing
167
160
****************************************
168
161
169
162
Enabling OPEA OpenTelemetry tracing for a function is straightforward.
170
163
First, import opea_telemetry, and then apply the Python decorator @opea_telemetry to the function you wish to trace.
171
164
Below is an example of how to trace your_func using OPEA tracing:
172
165
173
-
174
166
.. code-block:: python
175
167
176
168
from comps import opea_telemetry
@@ -179,5 +171,3 @@ Below is an example of how to trace your_func using OPEA tracing:
0 commit comments