[
https://issues.apache.org/jira/browse/PROTON-2487?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=17614221#comment-17614221
]
ASF GitHub Bot commented on PROTON-2487:
----------------------------------------
astitcher commented on code in PR #355:
URL: https://github.com/apache/qpid-proton/pull/355#discussion_r990334352
##########
cpp/examples/tracing.dox:
##########
@@ -0,0 +1,108 @@
+// -*-markdown-*-
+// NOTE: doxygen can include markdown pages directly but there seems to be a
bug
+// that shows messed-up line numbers in \skip \until code extracts. This file
+// is markdown wrapped in a doxygen comment - which works. The file is best
viewed/edited
+// as markdown.
+
+/**
+
+@page tracing Tracing
+
+The tracing support is added using OpenTelemetry-cpp.
+
+There are two types of spans that could be generated:
+1. <b>Library generated spans</b>:
+
+ Send span <b>("amqp-message-send”)</b> gets created just before sending a
message and ends when that message gets settled.
+
+ Receive span <b>("amqp-message-received")</b> gets created just before
receiving a message and ends as soon as the message is received.
+
+2. <b>Application generated spans</b>:
+
+ Users can also create their own spans and those spans will get linked with
the library generated spans.
+
+## Usage:
+
+Minimum requirements to enable tracing in proton:
+
+1. Include `<proton/tracing.hpp>`
+2. Initialize the exporter, set the Tracer Provider and include all the
related header files.
+3. Call `proton::initOpenTelemetryTracer()`
Review Comment:
This isn't the minimum any more - the user application has to initialise the
exporter otherwise nothing will be traced
##########
cpp/examples/tracing.dox:
##########
@@ -0,0 +1,108 @@
+// -*-markdown-*-
+// NOTE: doxygen can include markdown pages directly but there seems to be a
bug
+// that shows messed-up line numbers in \skip \until code extracts. This file
+// is markdown wrapped in a doxygen comment - which works. The file is best
viewed/edited
+// as markdown.
+
+/**
+
+@page tracing Tracing
+
+The tracing support is added using OpenTelemetry-cpp.
+
+There are two types of spans that could be generated:
+1. <b>Library generated spans</b>:
+
+ Send span <b>("amqp-message-send”)</b> gets created just before sending a
message and ends when that message gets settled.
+
+ Receive span <b>("amqp-message-received")</b> gets created just before
receiving a message and ends as soon as the message is received.
+
+2. <b>Application generated spans</b>:
+
+ Users can also create their own spans and those spans will get linked with
the library generated spans.
+
+## Usage:
+
+Minimum requirements to enable tracing in proton:
+
+1. Include `<proton/tracing.hpp>`
+2. Initialize the exporter, set the Tracer Provider and include all the
related header files.
+3. Call `proton::initOpenTelemetryTracer()`
+
+This will generates the library spans ("amqp-message-send" and
"amqp-message-received").
+
+In addition, users can create their own spans in the application. The @ref
tracing_client and @ref tracing_server examples demostrates how to do that.
+
+## Dependencies:
+
+ `THRIFT` AND `LIB_CURL` needed.
+
+Note: Thrift is jaeger exporter dependency.
+
+#### Steps to install thrift:
+
+ For debian-based system: apt-get install libthrift-dev
+ For rpm-based system : dnf install thrift-devel
+
+#### Steps to install libcurl:
+
+ For debian-based system: apt-get install libcurl4-openssl-dev
+ For rpm-based system : dnf install libcurl-devel
+
+
Review Comment:
This is no longer needed with the latest builds
> [cpp] Implement distributed tracing
> -----------------------------------
>
> Key: PROTON-2487
> URL: https://issues.apache.org/jira/browse/PROTON-2487
> Project: Qpid Proton
> Issue Type: New Feature
> Components: cpp-binding
> Affects Versions: proton-c-0.37.0
> Reporter: Rakhi Kumari
> Assignee: Rakhi Kumari
> Priority: Major
> Fix For: proton-c-0.38.0
>
>
> Implement distributed tracing using opentelemetry.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
