Resource sdk Implementation

examples/batch/BUILD

@@ -7,6 +7,7 @@ cc_binary(
     deps = [
         "//api",
         "//exporters/ostream:ostream_span_exporter",
+        "//sdk/src/resource",
         "//sdk/src/trace",
     ],
 )

examples/batch/CMakeLists.txt

@@ -4,4 +4,5 @@ add_executable(batch_span_processor_example main.cc)
 
 target_link_libraries(
   batch_span_processor_example ${CMAKE_THREAD_LIBS_INIT} ${CORE_RUNTIME_LIBS}
-  opentelemetry_exporter_ostream_span opentelemetry_trace)
+  opentelemetry_exporter_ostream_span opentelemetry_trace
+  opentelemetry_resources)

examples/multithreaded/BUILD

@@ -6,6 +6,7 @@ cc_binary(
     deps = [
         "//api",
         "//exporters/ostream:ostream_span_exporter",
+        "//sdk/src/resource",
         "//sdk/src/trace",
     ],
 )

examples/multithreaded/CMakeLists.txt

@@ -1,5 +1,6 @@
 include_directories(${CMAKE_SOURCE_DIR}/exporters/ostream/include)
 
 add_executable(example_multithreaded main.cc)
-target_link_libraries(example_multithreaded ${CMAKE_THREAD_LIBS_INIT}
-                      opentelemetry_trace opentelemetry_exporter_ostream_span)
+target_link_libraries(
+  example_multithreaded ${CMAKE_THREAD_LIBS_INIT} opentelemetry_trace
+  opentelemetry_resources opentelemetry_exporter_ostream_span)

examples/otlp/BUILD

@@ -20,6 +20,7 @@ cc_binary(
         ":foo_library",
         "//api",
         "//exporters/otlp:otlp_exporter",
+        "//sdk/src/resource",
         "//sdk/src/trace",
     ],
 )

examples/otlp/CMakeLists.txt

@@ -12,6 +12,7 @@ target_link_libraries(
   ${CMAKE_THREAD_LIBS_INIT}
   otlp_foo_library
   opentelemetry_trace
+  opentelemetry_resources
   ${CORE_RUNTIME_LIBS}
   opentelemetry_exporter_otprotocol
   gRPC::grpc++)

examples/simple/BUILD

@@ -20,6 +20,7 @@ cc_binary(
         ":foo_library",
         "//api",
         "//exporters/ostream:ostream_span_exporter",
+        "//sdk/src/resource",
         "//sdk/src/trace",
     ],
 )

examples/simple/CMakeLists.txt

@@ -6,4 +6,4 @@ target_link_libraries(foo_library opentelemetry_exporter_ostream_span
 
 add_executable(example_simple main.cc)
 target_link_libraries(example_simple ${CMAKE_THREAD_LIBS_INIT} foo_library
-                      opentelemetry_trace)
+                      opentelemetry_trace opentelemetry_resources)

examples/simple/main.cc

@@ -14,8 +14,10 @@ void initTracer()
       new opentelemetry::exporter::trace::OStreamSpanExporter);
   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));
+  auto provider =
+      nostd::shared_ptr<opentelemetry::trace::TracerProvider>(new sdktrace::TracerProvider(
+          processor, std::make_shared<opentelemetry::sdk::trace::AlwaysOnSampler>(),
+          opentelemetry::sdk::resource::Resource::Create({})));
   // Set the global trace provider
   opentelemetry::trace::Provider::SetTracerProvider(provider);
 }

examples/zpages/BUILD

@@ -26,6 +26,7 @@ cc_binary(
     deps = [
         "//ext:headers",
         "//ext/src/zpages",
+        "//sdk/src/resource",
         "//sdk/src/trace",
     ],
 )

exporters/otlp/BUILD

@@ -65,6 +65,7 @@ cc_test(
     deps = [
         ":otlp_exporter",
         "//api",
+        "//sdk/src/resource",
         "@com_google_googletest//:gtest_main",
     ],
 )

ext/src/zpages/CMakeLists.txt

@@ -10,7 +10,7 @@ set_target_properties(opentelemetry_zpages PROPERTIES EXPORT_NAME zpages)
 
 target_link_libraries(
   opentelemetry_zpages PUBLIC opentelemetry_ext opentelemetry_api
-                              opentelemetry_trace)
+                              opentelemetry_trace opentelemetry_resources)
 
 install(
   TARGETS opentelemetry_zpages

ext/test/zpages/BUILD

@@ -17,6 +17,7 @@ cc_test(
     ],
     deps = [
         "//ext/src/zpages",
+        "//sdk/src/resource",
         "//sdk/src/trace",
         "@com_google_googletest//:gtest_main",
     ],
@@ -29,6 +30,7 @@ cc_test(
     ],
     deps = [
         "//ext/src/zpages",
+        "//sdk/src/resource",
         "//sdk/src/trace",
         "@com_google_googletest//:gtest_main",
     ],

sdk/include/opentelemetry/sdk/resource/resource.h

@@ -0,0 +1,75 @@
+#pragma once
+
+#include "opentelemetry/sdk/common/attribute_utils.h"
+#include "opentelemetry/sdk/resource/resource_detector.h"
+#include "opentelemetry/sdk/version/version.h"
+#include "opentelemetry/version.h"
+
+#include <memory>
+#include <sstream>
+#include <unordered_map>
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace sdk
+{
+namespace resource
+{
+
+using ResourceAttributes =
+    std::unordered_map<std::string, opentelemetry::sdk::common::OwnedAttributeValue>;
+
+class Resource
+{
+public:
+  const ResourceAttributes &GetAttributes() const noexcept;
+
+  /**
+   * Returns a new, merged {@link Resource} by merging the current Resource
+   * with the other Resource. In case of a collision, current Resource takes
+   * precedence.
+   *
+   * @param other the Resource that will be merged with this.
+   * @returns the newly merged Resource.
+   */
+
+  Resource Merge(const Resource &other) noexcept;
+
+  /**
+   * Returns a newly created Resource with the specified attributes.
+   * It adds (merge) SDK attributes and OTEL attributes before returning.
+   * @param attributes for this resource
+   * @returns the newly created Resource.
+   */
+
+  static Resource Create(const ResourceAttributes &attributes);
+
+  /**
+   * Returns an Empty resource.
+   */
+
+  static Resource &GetEmpty();
+
+  /**
+   * Returns a Resource that indentifies the SDK in use.
+   */
+
+  static Resource &GetDefault();
+
+protected:
+  /**
+   * The constructor is private and only for use internally by the class and
+   * inside ResourceDetector class.
+   * Users should use the Create factory method to obtain a Resource
+   * instance.
+   */
+  Resource(const ResourceAttributes &attributes = ResourceAttributes()) noexcept;
+
+private:
+  ResourceAttributes attributes_;
+
+  friend class OTELResourceDetector;
+};
+
+}  // namespace resource
+}  // namespace sdk
+OPENTELEMETRY_END_NAMESPACE

sdk/include/opentelemetry/sdk/resource/resource_detector.h

@@ -0,0 +1,35 @@
+#pragma once
+
+#include "opentelemetry/nostd/unique_ptr.h"
+#include "opentelemetry/version.h"
+
+OPENTELEMETRY_BEGIN_NAMESPACE
+namespace sdk
+{
+namespace resource
+{
+
+class Resource;
+
+/**
+ * Interface for a Resource Detector
+ */
+class ResourceDetector
+{
+public:
+  virtual Resource Detect() = 0;
+};
+
+/**
+ * OTelResourceDetector to detect the presence of and create a Resource
+ * from the OTEL_RESOURCE_ATTRIBUTES environment variable.
+ */
+class OTELResourceDetector : public ResourceDetector
+{
+public:
+  Resource Detect() noexcept override;
+};
+
+}  // namespace resource
+}  // namespace sdk
+OPENTELEMETRY_END_NAMESPACE

sdk/include/opentelemetry/sdk/trace/tracer.h

@@ -1,6 +1,7 @@
 #pragma once
 
 #include "opentelemetry/sdk/common/atomic_shared_ptr.h"
+#include "opentelemetry/sdk/resource/resource.h"
 #include "opentelemetry/sdk/trace/processor.h"
 #include "opentelemetry/sdk/trace/samplers/always_on.h"
 #include "opentelemetry/trace/noop.h"
@@ -23,7 +24,9 @@ class Tracer final : public trace_api::Tracer, public std::enable_shared_from_th
    * nullptr.
    */
   explicit Tracer(std::shared_ptr<SpanProcessor> processor,
-                  std::shared_ptr<Sampler> sampler = std::make_shared<AlwaysOnSampler>()) noexcept;
+                  std::shared_ptr<Sampler> sampler = std::make_shared<AlwaysOnSampler>(),
+                  const opentelemetry::sdk::resource::Resource &resource =
+                      opentelemetry::sdk::resource::Resource::Create({})) noexcept;
 
   /**
    * Set the span processor associated with this tracer.
@@ -57,6 +60,7 @@ class Tracer final : public trace_api::Tracer, public std::enable_shared_from_th
 private:
   opentelemetry::sdk::AtomicSharedPtr<SpanProcessor> processor_;
   const std::shared_ptr<Sampler> sampler_;
+  const opentelemetry::sdk::resource::Resource &resource_;
 };
 }  // namespace trace
 }  // namespace sdk

sdk/include/opentelemetry/sdk/trace/tracer_provider.h

@@ -5,6 +5,7 @@
 #include <string>
 
 #include "opentelemetry/nostd/shared_ptr.h"
+#include "opentelemetry/sdk/resource/resource.h"
 #include "opentelemetry/sdk/trace/processor.h"
 #include "opentelemetry/sdk/trace/samplers/always_on.h"
 #include "opentelemetry/sdk/trace/tracer.h"
@@ -25,9 +26,10 @@ class TracerProvider final : public opentelemetry::trace::TracerProvider
    * @param sampler The sampler for this tracer provider. This must
    * not be a nullptr.
    */
-  explicit TracerProvider(
-      std::shared_ptr<SpanProcessor> processor,
-      std::shared_ptr<Sampler> sampler = std::make_shared<AlwaysOnSampler>()) noexcept;
+  explicit TracerProvider(std::shared_ptr<SpanProcessor> processor,
+                          std::shared_ptr<Sampler> sampler = std::make_shared<AlwaysOnSampler>(),
+                          opentelemetry::sdk::resource::Resource &&resource =
+                              opentelemetry::sdk::resource::Resource::Create({})) noexcept;
 
   opentelemetry::nostd::shared_ptr<opentelemetry::trace::Tracer> GetTracer(
       nostd::string_view library_name,
@@ -48,10 +50,16 @@ class TracerProvider final : public opentelemetry::trace::TracerProvider
 
   /**
    * Obtain the sampler associated with this tracer provider.
-   * @return The span processor for this tracer provider.
+   * @return The sampler for this tracer provider.
    */
   std::shared_ptr<Sampler> GetSampler() const noexcept;
 
+  /**
+   * Obtain the resource associated with this tracer provider.
+   * @return The resource for this tracer provider.
+   */
+  const opentelemetry::sdk::resource::Resource &GetResource() const noexcept;
+
   /**
    * Shutdown the span processor associated with this tracer provider.
    */
@@ -61,6 +69,7 @@ class TracerProvider final : public opentelemetry::trace::TracerProvider
   opentelemetry::sdk::AtomicSharedPtr<SpanProcessor> processor_;
   std::shared_ptr<opentelemetry::trace::Tracer> tracer_;
   const std::shared_ptr<Sampler> sampler_;
+  const opentelemetry::sdk::resource::Resource resource_;
 };
 }  // namespace trace
 }  // namespace sdk

sdk/src/CMakeLists.txt

@@ -3,3 +3,4 @@ add_subdirectory(trace)
 add_subdirectory(metrics)
 add_subdirectory(logs)
 add_subdirectory(version)
+add_subdirectory(resource)

sdk/src/resource/BUILD

@@ -0,0 +1,26 @@
+# Copyright 2020, OpenTelemetry Authors
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+package(default_visibility = ["//visibility:public"])
+
+cc_library(
+    name = "resource",
+    srcs = glob(["**/*.cc"]),
+    hdrs = glob(["**/*.h"]),
+    include_prefix = "src/resource",
+    deps = [
+        "//api",
+        "//sdk:headers",
+    ],
+)

sdk/src/resource/CMakeLists.txt

@@ -0,0 +1,16 @@
+add_library(opentelemetry_resources resource.cc resource_detector.cc)
+
+set_target_properties(opentelemetry_resources PROPERTIES EXPORT_NAME resources)
+
+target_link_libraries(opentelemetry_resources opentelemetry_common)
+
+target_include_directories(
+  opentelemetry_resources
+  PUBLIC "$<BUILD_INTERFACE:${PROJECT_SOURCE_DIR}/sdk/include>")
+
+install(
+  TARGETS opentelemetry_resources
+  EXPORT "${PROJECT_NAME}-target"
+  RUNTIME DESTINATION ${CMAKE_INSTALL_BINDIR}
+  LIBRARY DESTINATION ${CMAKE_INSTALL_LIBDIR}
+  ARCHIVE DESTINATION ${CMAKE_INSTALL_LIBDIR})