Add single link

open-telemetry · Oct 22, 2023 · 5356600 · 5356600
1 parent 76ce23b
commit 5356600
Show file tree

Hide file tree

Showing 9 changed files with 285 additions and 53 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -36,7 +36,8 @@ Important changes:
 
 * [API] Add a new AddLink() operation to Span
   [#2380](https://github.com/open-telemetry/opentelemetry-cpp/pull/2380)
-  * new `API` Span::AddLink() adds links to a span.
+  * New `API` Span::AddLink() adds a single link to a span.
+  * New `API` Span::AddLinks() adds multiple links to a span.
   * Because this is an `ABI` breaking change, the fix is only available
     with the `CMake` option `WITH_ABI_VERSION_2=ON`.
   * When building with `CMake` option `WITH_ABI_VERSION_1=ON` (by default)

diff --git a/api/include/opentelemetry/plugin/tracer.h b/api/include/opentelemetry/plugin/tracer.h
@@ -51,9 +51,15 @@ class Span final : public trace::Span
   }
 
 #if OPENTELEMETRY_ABI_VERSION_NO >= 2
-  void AddLink(const trace::SpanContextKeyValueIterable *links) noexcept override
+  void AddLink(const trace::SpanContext &target,
+               const common::KeyValueIterable &attrs) noexcept override
   {
-    span_->AddLink(links);
+    span_->AddLink(target, attrs);
+  }
+
+  void AddLinks(const trace::SpanContextKeyValueIterable &links) noexcept override
+  {
+    span_->AddLinks(links);
   }
 #endif
 

diff --git a/api/include/opentelemetry/trace/default_span.h b/api/include/opentelemetry/trace/default_span.h
@@ -48,7 +48,10 @@ class DefaultSpan : public Span
   {}
 
 #if OPENTELEMETRY_ABI_VERSION_NO >= 2
-  void AddLink(const SpanContextKeyValueIterable * /* links */) noexcept override {}
+  void AddLink(const SpanContext & /* target */,
+               const common::KeyValueIterable & /* attrs */) noexcept override
+  {}
+  void AddLinks(const SpanContextKeyValueIterable & /* links */) noexcept override {}
 #endif
 
   void SetStatus(StatusCode /* status */, nostd::string_view /* description */) noexcept override {}

diff --git a/api/include/opentelemetry/trace/noop.h b/api/include/opentelemetry/trace/noop.h
@@ -60,7 +60,11 @@ class OPENTELEMETRY_EXPORT NoopSpan final : public Span
   {}
 
 #if OPENTELEMETRY_ABI_VERSION_NO >= 2
-  void AddLink(const SpanContextKeyValueIterable * /* links */) noexcept override {}
+  void AddLink(const SpanContext & /* target */,
+               const common::KeyValueIterable & /* attrs */) noexcept override
+  {}
+
+  void AddLinks(const SpanContextKeyValueIterable & /* links */) noexcept override {}
 #endif
 
   void SetStatus(StatusCode /*code*/, nostd::string_view /*description*/) noexcept override {}

diff --git a/api/include/opentelemetry/trace/span.h b/api/include/opentelemetry/trace/span.h
@@ -103,31 +103,72 @@ class Span
 
 #if OPENTELEMETRY_ABI_VERSION_NO >= 2
 
+  /**
+   * Add link (ABI).
+   *
+   * @since ABI_VERSION 2
+   */
+  virtual void AddLink(const SpanContext &target,
+                       const common::KeyValueIterable &attrs) noexcept = 0;
+
   /**
    * Add links (ABI).
    *
    * @since ABI_VERSION 2
    */
-  virtual void AddLink(const SpanContextKeyValueIterable *links) noexcept = 0;
+  virtual void AddLinks(const SpanContextKeyValueIterable &links) noexcept = 0;
+
+  /**
+   * Add link (API helper).
+   *
+   * @since ABI_VERSION 2
+   */
+  template <class U,
+            nostd::enable_if_t<common::detail::is_key_value_iterable<U>::value> * = nullptr>
+  void AddLink(const SpanContext &target, const U &attrs)
+  {
+    common::KeyValueIterableView<U> view(attrs);
+    this->AddLink(target, view);
+  }
+
+  /**
+   * Add link (API helper).
+   *
+   * @since ABI_VERSION 2
+   */
+  void AddLink(const SpanContext &target,
+               std::initializer_list<std::pair<nostd::string_view, common::AttributeValue>> attrs)
+  {
+    /* Build a container from std::initializer_list. */
+    nostd::span<const std::pair<nostd::string_view, common::AttributeValue>> container{
+        attrs.begin(), attrs.end()};
+
+    /* Build a view on the container. */
+    common::KeyValueIterableView<
+        nostd::span<const std::pair<nostd::string_view, common::AttributeValue>>>
+        view(container);
+
+    return this->AddLink(target, view);
+  }
 
   /**
    * Add links (API helper).
    *
    * @since ABI_VERSION 2
    */
   template <class U, nostd::enable_if_t<detail::is_span_context_kv_iterable<U>::value> * = nullptr>
-  void AddLink(const U &links)
+  void AddLinks(const U &links)
   {
     SpanContextKeyValueIterableView<U> view(links);
-    this->AddLink(&view);
+    this->AddLinks(view);
   }
 
   /**
    * Add links (API helper).
    *
    * @since ABI_VERSION 2
    */
-  void AddLink(
+  void AddLinks(
       std::initializer_list<
           std::pair<SpanContext,
                     std::initializer_list<std::pair<nostd::string_view, common::AttributeValue>>>>
@@ -136,14 +177,14 @@ class Span
     /* Build a container from std::initializer_list. */
     nostd::span<const std::pair<
         SpanContext, std::initializer_list<std::pair<nostd::string_view, common::AttributeValue>>>>
-        links_span{links.begin(), links.end()};
+        container{links.begin(), links.end()};
 
     /* Build a view on the container. */
     SpanContextKeyValueIterableView<nostd::span<const std::pair<
         SpanContext, std::initializer_list<std::pair<nostd::string_view, common::AttributeValue>>>>>
-        view(links_span);
+        view(container);
 
-    return this->AddLink(&view);
+    return this->AddLinks(view);
   }
 
 #endif /* OPENTELEMETRY_ABI_VERSION_NO */

diff --git a/examples/plugin/plugin/tracer.cc b/examples/plugin/plugin/tracer.cc
@@ -50,7 +50,11 @@ class Span final : public trace::Span
   {}
 
 #if OPENTELEMETRY_ABI_VERSION_NO >= 2
-  void AddLink(const trace::SpanContextKeyValueIterable * /* links */) noexcept override {}
+  void AddLink(const trace::SpanContext &target,
+               const common::KeyValueIterable &attrs) noexcept override
+  {}
+
+  void AddLinks(const trace::SpanContextKeyValueIterable & /* links */) noexcept override {}
 #endif
 
   void SetStatus(trace::StatusCode /*code*/, nostd::string_view /*description*/) noexcept override

diff --git a/sdk/src/trace/span.cc b/sdk/src/trace/span.cc
@@ -147,16 +147,28 @@ void Span::AddEvent(nostd::string_view name,
 }
 
 #if OPENTELEMETRY_ABI_VERSION_NO >= 2
-void Span::AddLink(const opentelemetry::trace::SpanContextKeyValueIterable *links) noexcept
+void Span::AddLink(const opentelemetry::trace::SpanContext &target,
+                   const opentelemetry::common::KeyValueIterable &attrs) noexcept
 {
   std::lock_guard<std::mutex> lock_guard{mu_};
   if (recordable_ == nullptr)
   {
     return;
   }
 
-  links->ForEachKeyValue([&](opentelemetry::trace::SpanContext span_context,
-                             const common::KeyValueIterable &attributes) {
+  recordable_->AddLink(target, attrs);
+}
+
+void Span::AddLinks(const opentelemetry::trace::SpanContextKeyValueIterable &links) noexcept
+{
+  std::lock_guard<std::mutex> lock_guard{mu_};
+  if (recordable_ == nullptr)
+  {
+    return;
+  }
+
+  links.ForEachKeyValue([&](opentelemetry::trace::SpanContext span_context,
+                            const common::KeyValueIterable &attributes) {
     recordable_->AddLink(span_context, attributes);
     return true;
   });

diff --git a/sdk/src/trace/span.h b/sdk/src/trace/span.h
@@ -46,7 +46,10 @@ class Span final : public opentelemetry::trace::Span
                  nostd::string_view description) noexcept override;
 
 #if OPENTELEMETRY_ABI_VERSION_NO >= 2
-  void AddLink(const opentelemetry::trace::SpanContextKeyValueIterable *links) noexcept override;
+  void AddLink(const opentelemetry::trace::SpanContext &target,
+               const opentelemetry::common::KeyValueIterable &attrs) noexcept override;
+
+  void AddLinks(const opentelemetry::trace::SpanContextKeyValueIterable &links) noexcept override;
 #endif
 
   void UpdateName(nostd::string_view name) noexcept override;