Skip to content

Commit f11b8cc

Browse files
committed
removing redundant empty lines
Signed-off-by: Tsai, Louie <[email protected]>
1 parent fbd6413 commit f11b8cc

File tree

1 file changed

+0
-10
lines changed

1 file changed

+0
-10
lines changed

tutorial/OpenTelemetry/OpenTelemetry_OPEA_Guide.rst

-10
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ OTel enables developers to instrument, generate, collect, and export telemetry d
1010
The telemetry data can come in the form of traces, metrics, and logs.
1111
OPEA integrates OpenTelemetry's metrics and tracing capabilities to enhance its telemetry support, providing users with valuable insights into system performance.
1212

13-
1413
How It Works
1514
************
1615
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
1918
:width: 800
2019
:alt: Alternative text
2120

22-
23-
2421
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.
2522
For further guidance, please refer to the section on `Telemetry Metrics <https://github.com/opea-project/GenAIComps/tree/main/comps/cores/telemetry#metrics>`_.
2623
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
3027
The Jaeger UI monitors trace events from OPEA microservices, TEI, and TGI. Once Jaeger endpoints are configured in OPEA microservices, TEI, and TGI,
3128
trace data will automatically be reported and visualized in the Jaeger UI.
3229

33-
3430
Deployment
3531
**********
3632

@@ -111,7 +107,6 @@ These sections offer insights into how to interpret the data and utilize the das
111107
ChatQnA <deploy/ChatQnA>
112108
AgentQnA <deploy/AgentQnA>
113109

114-
115110
3. Jaeger
116111
+++++++++++++++
117112

@@ -144,7 +139,6 @@ Select "opea" as the service, then click the "Find Traces" button to view the tr
144139
:width: 400
145140
:alt: Alternative text
146141

147-
148142
All traces will be displayed on the UI.
149143
The diagram in the upper right corner provides a visual representation of all requests along the timeline. Meanwhile,
150144
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
162156
ChatQnA <deploy/ChatQnA>
163157
AgentQnA <deploy/AgentQnA>
164158

165-
166159
Code Instrumentations for OPEA Tracing
167160
****************************************
168161

169162
Enabling OPEA OpenTelemetry tracing for a function is straightforward.
170163
First, import opea_telemetry, and then apply the Python decorator @opea_telemetry to the function you wish to trace.
171164
Below is an example of how to trace your_func using OPEA tracing:
172165

173-
174166
.. code-block:: python
175167
176168
from comps import opea_telemetry
@@ -179,5 +171,3 @@ Below is an example of how to trace your_func using OPEA tracing:
179171
async def your_func():
180172
pass
181173
182-
183-

0 commit comments

Comments
 (0)