Rename InstrumentationLibrary -> InstrumentationScope

Signed-off-by: owentou <[email protected]>
open-telemetry · Jul 22, 2022 · 2e6ad6f · 2e6ad6f
1 parent 09092cd
commit 2e6ad6f
Show file tree

Hide file tree

Showing 59 changed files with 476 additions and 366 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -22,6 +22,7 @@ Increment the:
 * [EXT] `curl::HttpClient` use `curl_multi_handle` instead of creating a thread
  for every request and it's able to reuse connections now. ([#1317](https:/open-telemetry/opentelemetry-cpp/pull/1317))
 * [SEMANTIC CONVENTIONS] Upgrade to version 1.12.0 [#873](https:/open-telemetry/opentelemetry-cpp/pull/873)
+* [SDK] Rename `InstrumentationLibrary` to `InstrumentationScope` [#1507](https:/open-telemetry/opentelemetry-cpp/pull/1507)
 
 ## [1.4.1] 2022-06-19
 

diff --git a/docs/public/Doxyfile b/docs/public/Doxyfile
@@ -800,6 +800,7 @@ INPUT = \
  ../../api/include/opentelemetry/nostd/unique_ptr.h \
  ../../api/include/opentelemetry/nostd/variant.h \
  ../../api/include/opentelemetry/trace \
+ ../../sdk/include/opentelemetry/sdk/instrumentationscope \
  ../../sdk/include/opentelemetry/sdk/instrumentationlibrary \
  ../../sdk/include/opentelemetry/sdk/resource \
  ../../sdk/include/opentelemetry/sdk/trace

diff --git a/exporters/elasticsearch/include/opentelemetry/exporters/elasticsearch/es_log_recordable.h b/exporters/elasticsearch/include/opentelemetry/exporters/elasticsearch/es_log_recordable.h
@@ -10,6 +10,7 @@
 # include <unordered_map>
 
 # include "nlohmann/json.hpp"
+# include "opentelemetry/common/macros.h"
 # include "opentelemetry/sdk/common/attribute_utils.h"
 # include "opentelemetry/sdk/logs/recordable.h"
 # include "opentelemetry/version.h"
@@ -201,27 +202,42 @@ class ElasticSearchRecordable final : public sdk::logs::Recordable
  nlohmann::json GetJSON() noexcept { return json_; }
 
  /**
- * Set instrumentation_library for this log.
- * @param instrumentation_library the instrumentation library to set
+ * Set instrumentation_scope for this log.
+ * @param instrumentation_scopehe instrumentation library to set
  */
+ void SetInstrumentationScope(const opentelemetry::sdk::instrumentationscope::InstrumentationScope
+ &instrumentation_scope) noexcept
+ {
+ json_["name"] = instrumentation_scope.GetName();
+ instrumentation_scope_ = &instrumentation_scope;
+ }
+
+ OPENTELEMETRY_DEPRECATED_MESSAGE("Please use SetInstrumentationScope instead")
  void SetInstrumentationLibrary(
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- &instrumentation_library) noexcept
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope
+ &instrumentation_scope) noexcept
+ {
+ SetInstrumentationScope(instrumentation_scope);
+ }
+
+ /** Returns the associated instruementation library */
+ OPENTELEMETRY_DEPRECATED_MESSAGE("Please use GetInstrumentationScope instead")
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope &GetInstrumentationLibrary()
+ const noexcept
  {
- json_["name"] = instrumentation_library.GetName();
- instrumentation_library_ = &instrumentation_library;
+ return GetInstrumentationScope();
  }
 
  /** Returns the associated instruementation library */
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary &
- GetInstrumentationLibrary() const noexcept
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope &GetInstrumentationScope()
+   const noexcept
  {
- return *instrumentation_library_;
+ return *instrumentation_scope_;
  }
 
 private:
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- *instrumentation_library_ = nullptr;
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope *instrumentation_scope_ =
+ nullptr;
 };
 } // namespace logs
 } // namespace exporter

diff --git a/exporters/jaeger/include/opentelemetry/exporters/jaeger/recordable.h b/exporters/jaeger/include/opentelemetry/exporters/jaeger/recordable.h
@@ -86,9 +86,8 @@ class JaegerRecordable final : public sdk::trace::Recordable
 
  void SetDuration(std::chrono::nanoseconds duration) noexcept override;
 
- void SetInstrumentationLibrary(
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- &instrumentation_library) noexcept override;
+ void SetInstrumentationScope(const opentelemetry::sdk::instrumentationscope::InstrumentationScope
+ &instrumentation_scope) noexcept override;
 
 private:
  void AddTag(const std::string &key, const std::string &value, std::vector<thrift::Tag> &tags);

diff --git a/exporters/jaeger/src/recordable.cc b/exporters/jaeger/src/recordable.cc
@@ -182,12 +182,12 @@ void JaegerRecordable::AddEvent(nostd::string_view name,
  logs_.push_back(log);
 }
 
-void JaegerRecordable::SetInstrumentationLibrary(
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- &instrumentation_library) noexcept
+void JaegerRecordable::SetInstrumentationScope(
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope
+ &instrumentation_scope) noexcept
 {
- AddTag("otel.library.name", instrumentation_library.GetName(), tags_);
- AddTag("otel.library.version", instrumentation_library.GetVersion(), tags_);
+ AddTag("otel.library.name", instrumentation_scope.GetName(), tags_);
+ AddTag("otel.library.version", instrumentation_scope.GetVersion(), tags_);
 }
 
 void JaegerRecordable::AddLink(const trace::SpanContext &span_context,

diff --git a/exporters/jaeger/test/jaeger_recordable_test.cc b/exporters/jaeger/test/jaeger_recordable_test.cc
@@ -3,7 +3,7 @@
 
 #include <vector>
 #include "opentelemetry/exporters/jaeger/recordable.h"
-#include "opentelemetry/sdk/instrumentationlibrary/instrumentation_library.h"
+#include "opentelemetry/sdk/instrumentationscope/instrumentation_scope.h"
 #include "opentelemetry/sdk/trace/simple_processor.h"
 #include "opentelemetry/sdk/trace/span_data.h"
 #include "opentelemetry/sdk/trace/tracer_provider.h"
@@ -18,7 +18,7 @@ namespace common = opentelemetry::common;
 
 using namespace jaegertracing;
 using namespace opentelemetry::exporter::jaeger;
-using namespace opentelemetry::sdk::instrumentationlibrary;
+using namespace opentelemetry::sdk::instrumentationscope;
 using std::vector;
 
 using Attributes = std::initializer_list<std::pair<nostd::string_view, common::AttributeValue>>;
@@ -247,15 +247,15 @@ TEST(JaegerSpanRecordable, SetAttributes)
  EXPECT_EQ(tags, expected_tags);
 }
 
-TEST(JaegerSpanRecordable, SetInstrumentationLibrary)
+TEST(JaegerSpanRecordable, SetInstrumentationScope)
 {
  JaegerRecordable rec;
 
- std::string library_name  = "opentelemetry-cpp";
- std::string library_version  = "0.1.0";
- auto instrumentation_library = InstrumentationLibrary::Create(library_name, library_version);
+ std::string library_name = "opentelemetry-cpp";
+ std::string library_version = "0.1.0";
+ auto instrumentation_scope = InstrumentationScope::Create(library_name, library_version);
 
- rec.SetInstrumentationLibrary(*instrumentation_library);
+ rec.SetInstrumentationScope(*instrumentation_scope);
 
  auto tags = rec.Tags();
  EXPECT_EQ(tags.size(), 2);

diff --git a/exporters/ostream/include/opentelemetry/exporters/ostream/span_exporter.h b/exporters/ostream/include/opentelemetry/exporters/ostream/span_exporter.h
@@ -61,9 +61,8 @@ class OStreamSpanExporter final : public opentelemetry::sdk::trace::SpanExporter
 
  void printResources(const opentelemetry::sdk::resource::Resource &resources);
 
- void printInstrumentationLibrary(
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- &instrumentation_library);
+ void printInstrumentationScope(
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope &instrumentation_scope);
 };
 } // namespace trace
 } // namespace exporter

diff --git a/exporters/ostream/src/span_exporter.cc b/exporters/ostream/src/span_exporter.cc
@@ -90,7 +90,7 @@ sdk::common::ExportResult OStreamSpanExporter::Export(
  sout_ << "\n resources : ";
  printResources(span->GetResource());
  sout_ << "\n instr-lib : ";
- printInstrumentationLibrary(span->GetInstrumentationLibrary());
+ printInstrumentationScope(span->GetInstrumentationScope());
  sout_ << "\n}\n";
  }
  }
@@ -161,12 +161,11 @@ void OStreamSpanExporter::printResources(const opentelemetry::sdk::resource::Res
  }
 }
 
-void OStreamSpanExporter::printInstrumentationLibrary(
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- &instrumentation_library)
+void OStreamSpanExporter::printInstrumentationScope(
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope &instrumentation_scope)
 {
- sout_ << instrumentation_library.GetName();
- auto version = instrumentation_library.GetVersion();
+ sout_ << instrumentation_scope.GetName();
+ auto version = instrumentation_scope.GetVersion();
  if (version.size())
  {
  sout_ << "-" << version;

diff --git a/exporters/ostream/test/ostream_metric_test.cc b/exporters/ostream/test/ostream_metric_test.cc
@@ -41,7 +41,7 @@ TEST(OStreamMetricsExporter, ExportSumPointData)
  auto resource = opentelemetry::sdk::resource::Resource::Create(
  opentelemetry::sdk::resource::ResourceAttributes{});
  data.resource_ = &resource;
- auto scope = opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary::Create(
+ auto scope = opentelemetry::sdk::instrumentationscope::InstrumentationScope::Create(
  "library_name", "1.2.0");
  metric_sdk::MetricData metric_data{
  metric_sdk::InstrumentDescriptor{"library_name", "description", "unit",
@@ -104,7 +104,7 @@ TEST(OStreamMetricsExporter, ExportHistogramPointData)
  auto resource = opentelemetry::sdk::resource::Resource::Create(
  opentelemetry::sdk::resource::ResourceAttributes{});
  data.resource_ = &resource;
- auto scope = opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary::Create(
+ auto scope = opentelemetry::sdk::instrumentationscope::InstrumentationScope::Create(
  "library_name", "1.2.0");
  metric_sdk::MetricData metric_data{
  metric_sdk::InstrumentDescriptor{"library_name", "description", "unit",
@@ -164,7 +164,7 @@ TEST(OStreamMetricsExporter, ExportLastValuePointData)
  auto resource = opentelemetry::sdk::resource::Resource::Create(
  opentelemetry::sdk::resource::ResourceAttributes{});
  data.resource_ = &resource;
- auto scope = opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary::Create(
+ auto scope = opentelemetry::sdk::instrumentationscope::InstrumentationScope::Create(
  "library_name", "1.2.0");
  metric_sdk::LastValuePointData last_value_point_data{};
  last_value_point_data.value_ = 10.0;
@@ -227,7 +227,7 @@ TEST(OStreamMetricsExporter, ExportDropPointData)
  auto resource = opentelemetry::sdk::resource::Resource::Create(
  opentelemetry::sdk::resource::ResourceAttributes{});
  data.resource_ = &resource;
- auto scope = opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary::Create(
+ auto scope = opentelemetry::sdk::instrumentationscope::InstrumentationScope::Create(
  "library_name", "1.2.0");
  metric_sdk::DropPointData drop_point_data{};
  metric_sdk::DropPointData drop_point_data2{};

diff --git a/exporters/otlp/include/opentelemetry/exporters/otlp/otlp_log_recordable.h b/exporters/otlp/include/opentelemetry/exporters/otlp/otlp_log_recordable.h
@@ -9,11 +9,12 @@
 
 # include "opentelemetry/proto/logs/v1/logs.pb.h"
 # include "opentelemetry/proto/resource/v1/resource.pb.h"
-# include "opentelemetry/sdk/instrumentationlibrary/instrumentation_library.h"
+# include "opentelemetry/sdk/instrumentationscope/instrumentation_scope.h"
 
 # include "opentelemetry/exporters/otlp/protobuf_include_suffix.h"
 // clang-format on
 
+# include "opentelemetry/common/macros.h"
 # include "opentelemetry/sdk/common/attribute_utils.h"
 # include "opentelemetry/sdk/logs/recordable.h"
 
@@ -91,24 +92,30 @@ class OtlpLogRecordable final : public opentelemetry::sdk::logs::Recordable
  void SetTraceFlags(opentelemetry::trace::TraceFlags trace_flags) noexcept override;
 
  /**
- * Set instrumentation_library for this log.
- * @param instrumentation_library the instrumentation library to set
+ * Set instrumentation_scope for this log.
+ * @param instrumentation_scopehe instrumentation library to set
  */
- void SetInstrumentationLibrary(
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- &instrumentation_library) noexcept override;
+ void SetInstrumentationScope(const opentelemetry::sdk::instrumentationscope::InstrumentationScope
+ &instrumentation_scope) noexcept override;
+
+ OPENTELEMETRY_DEPRECATED_MESSAGE("Please use GetInstrumentationScope instead")
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope &GetInstrumentationLibrary()
+ const noexcept
+ {
+ return GetInstrumentationScope();
+ }
 
  /** Returns the associated instruementation library */
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary &
- GetInstrumentationLibrary() const noexcept;
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope &GetInstrumentationScope()
+   const noexcept;
 
 private:
  proto::logs::v1::LogRecord log_record_;
  const opentelemetry::sdk::resource::Resource *resource_ = nullptr;
  // TODO shared resource
  // const opentelemetry::sdk::resource::Resource *resource_ = nullptr;
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- *instrumentation_library_ = nullptr;
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope *instrumentation_scope_ =
+ nullptr;
 };
 
 } // namespace otlp

diff --git a/exporters/otlp/include/opentelemetry/exporters/otlp/otlp_recordable.h b/exporters/otlp/include/opentelemetry/exporters/otlp/otlp_recordable.h
@@ -57,15 +57,15 @@ class OtlpRecordable final : public opentelemetry::sdk::trace::Recordable
 
  void SetDuration(std::chrono::nanoseconds duration) noexcept override;
 
- void SetInstrumentationLibrary(
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- &instrumentation_library) noexcept override;
+ void SetInstrumentationScope(
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope
+ &instrumentation_scope) noexcept override;
 
 private:
  proto::trace::v1::Span span_;
  const opentelemetry::sdk::resource::Resource *resource_ = nullptr;
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- *instrumentation_library_ = nullptr;
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope *instrumentation_scope_ =
+ nullptr;
 };
 } // namespace otlp
 } // namespace exporter

diff --git a/exporters/otlp/src/otlp_log_recordable.cc b/exporters/otlp/src/otlp_log_recordable.cc
@@ -210,22 +210,22 @@ void OtlpLogRecordable::SetTraceFlags(opentelemetry::trace::TraceFlags trace_fla
  log_record_.set_flags(trace_flags.flags());
 }
 
-void OtlpLogRecordable::SetInstrumentationLibrary(
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- &instrumentation_library) noexcept
+void OtlpLogRecordable::SetInstrumentationScope(
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope
+ &instrumentation_scope) noexcept
 {
- instrumentation_library_ = &instrumentation_library;
+ instrumentation_scope_ = &instrumentation_scope;
 }
 
-const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary &
-OtlpLogRecordable::GetInstrumentationLibrary() const noexcept
+const opentelemetry::sdk::instrumentationscope::InstrumentationScope &
+OtlpLogRecordable::GetInstrumentationScope() const noexcept
 {
- OPENTELEMETRY_LIKELY_IF(nullptr != instrumentation_library_) { return *instrumentation_library_; }
+ OPENTELEMETRY_LIKELY_IF(nullptr != instrumentation_scope_) { return *instrumentation_scope_; }
 
  static opentelemetry::nostd::unique_ptr<
- opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary>
+ opentelemetry::sdk::instrumentationscope::InstrumentationScope>
  default_instrumentation =
- opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary::Create(
+ opentelemetry::sdk::instrumentationscope::InstrumentationScope::Create(
  "default", "1.0.0", "https://opentelemetry.io/schemas/1.11.0");
  return *default_instrumentation;
 }

diff --git a/exporters/otlp/src/otlp_recordable.cc b/exporters/otlp/src/otlp_recordable.cc
@@ -54,9 +54,9 @@ const std::string OtlpRecordable::GetResourceSchemaURL() const noexcept
 const std::string OtlpRecordable::GetInstrumentationLibrarySchemaURL() const noexcept
 {
  std::string schema_url;
- if (instrumentation_library_)
+ if (instrumentation_scope_)
  {
- schema_url = instrumentation_library_->GetSchemaURL();
+ schema_url = instrumentation_scope_->GetSchemaURL();
  }
 
  return schema_url;
@@ -66,10 +66,10 @@ proto::common::v1::InstrumentationScope OtlpRecordable::GetProtoInstrumentationS
  const noexcept
 {
  proto::common::v1::InstrumentationScope instrumentation_scope;
- if (instrumentation_library_)
+ if (instrumentation_scope_)
  {
- instrumentation_scope.set_name(instrumentation_library_->GetName());
- instrumentation_scope.set_version(instrumentation_library_->GetVersion());
+ instrumentation_scope.set_name(instrumentation_scope_->GetName());
+ instrumentation_scope.set_version(instrumentation_scope_->GetVersion());
  }
  return instrumentation_scope;
 }
@@ -176,11 +176,11 @@ void OtlpRecordable::SetDuration(std::chrono::nanoseconds duration) noexcept
  span_.set_end_time_unix_nano(unix_end_time);
 }
 
-void OtlpRecordable::SetInstrumentationLibrary(
- const opentelemetry::sdk::instrumentationlibrary::InstrumentationLibrary
- &instrumentation_library) noexcept
+void OtlpRecordable::SetInstrumentationScope(
+ const opentelemetry::sdk::instrumentationscope::InstrumentationScope
+ &instrumentation_scope) noexcept
 {
- instrumentation_library_ = &instrumentation_library;
+ instrumentation_scope_ = &instrumentation_scope;
 }
 
 } // namespace otlp