summaryrefslogtreecommitdiffstats
path: root/src/jaegertracing/opentelemetry-cpp/exporters/zipkin/README.md
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-21 11:54:28 +0000
commite6918187568dbd01842d8d1d2c808ce16a894239 (patch)
tree64f88b554b444a49f656b6c656111a145cbbaa28 /src/jaegertracing/opentelemetry-cpp/exporters/zipkin/README.md
parentInitial commit. (diff)
downloadceph-e6918187568dbd01842d8d1d2c808ce16a894239.tar.xz
ceph-e6918187568dbd01842d8d1d2c808ce16a894239.zip
Adding upstream version 18.2.2.upstream/18.2.2
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/jaegertracing/opentelemetry-cpp/exporters/zipkin/README.md')
-rw-r--r--src/jaegertracing/opentelemetry-cpp/exporters/zipkin/README.md56
1 files changed, 56 insertions, 0 deletions
diff --git a/src/jaegertracing/opentelemetry-cpp/exporters/zipkin/README.md b/src/jaegertracing/opentelemetry-cpp/exporters/zipkin/README.md
new file mode 100644
index 000000000..40bb1f061
--- /dev/null
+++ b/src/jaegertracing/opentelemetry-cpp/exporters/zipkin/README.md
@@ -0,0 +1,56 @@
+# Zipkin Exporter for OpenTelemetry C++
+
+## Prerequisite
+
+* [Get Zipkin](https://zipkin.io/pages/quickstart.html)
+
+## Installation
+
+### CMake Install Instructions
+
+Refer to install instructions [INSTALL.md](../../INSTALL.md#building-as-standalone-cmake-project).
+Modify step 2 to create `cmake` build configuration for compiling Zipkin as below:
+
+```console
+ $ cmake -DWITH_ZIPKIN=ON ..
+ -- The C compiler identification is GNU 9.3.0
+ -- The CXX compiler identification is GNU 9.3.0
+ ...
+ -- Configuring done
+ -- Generating done
+ -- Build files have been written to: /home/<user>/source/opentelemetry-cpp/build
+ $
+```
+
+### Bazel Install Instructions
+
+TODO
+
+## Usage
+
+Install the exporter on your application and pass the options. `service_name`
+is an optional string. If omitted, the exporter will first try to get the
+service name from the Resource. If no service name can be detected on the
+Resource, a fallback name of "unknown_service" will be used.
+
+```cpp
+
+opentelemetry::exporter::zipkin::ZipkinExporterOptions options;
+options.endpoint = "http://localhost:9411/api/v2/spans";
+options.service_name = "my_service";
+
+auto exporter = std::unique_ptr<opentelemetry::sdk::trace::SpanExporter>(
+ new opentelemetry::exporter::zipkin::ZipkinExporter(options));
+auto processor = std::shared_ptr<sdktrace::SpanProcessor>(
+ new sdktrace::SimpleSpanProcessor(std::move(exporter)));
+auto provider = nostd::shared_ptr<opentelemetry::trace::TracerProvider>(
+ new sdktrace::TracerProvider(processor, opentelemetry::sdk::resource::Resource::Create({}),
+ std::make_shared<opentelemetry::sdk::trace::AlwaysOnSampler>()));
+
+// Set the global trace provider
+opentelemetry::trace::Provider::SetTracerProvider(provider);
+```
+
+## Viewing your traces
+
+Please visit the Zipkin UI endpoint <http://localhost:9411>