Add Recordable implementation for otprotocol exporter

.circleci/config.yml

@@ -12,7 +12,9 @@ jobs:
       - checkout
       - run: ./ci/setup_ci_environment.sh
       - run: ./ci/setup_cmake.sh
+      - run: ./ci/install_protobuf.sh
       - run: ./ci/do_ci.sh cmake.test
+      - run: ./ci/do_ci.sh cmake.exporter.otprotocol.test
       - store_artifacts:
           path: ~/build/Testing/Temporary/LastTest.log
           destination: Test.log
@@ -112,6 +114,7 @@ jobs:
       - run: ./ci/setup_windows_cmake.ps1
       - run: ./ci/setup_windows_ci_environment.ps1
       - run: ./ci/do_ci.ps1 cmake.test
+      - run: ./ci/do_ci.sh cmake.exporter.otprotocol.test
 
   windows_plugin_test:
     executor: win/vs2019

CMakeLists.txt

@@ -8,10 +8,27 @@ project(opentelemetry-cpp)
 
 set(CMAKE_CXX_STANDARD 11)
 
+option(WITH_OTPROTOCOL
+       "Whether to include the OpenTelemetry Protocol in the SDK" OFF)
+
+set(WITH_PROTOBUF OFF)
+if(WITH_OTPROTOCOL)
+  set(WITH_PROTOBUF ON)
+endif()
+
 include(CTest)
 
 find_package(Threads)
 
+if(WITH_PROTOBUF)
+  set(protobuf_MODULE_COMPATIBLE ON)
+  find_package(Protobuf CONFIG NAMES protobuf)
+  # Older versions of protobuf don't use cmake config files.
+  if(NOT protobuf_FOUND)
+    find_package(Protobuf REQUIRED)
+  endif()
+endif()
+
 if(BUILD_TESTING)
   find_package(GTest REQUIRED)
   find_package(benchmark REQUIRED)
@@ -20,4 +37,7 @@ endif()
 
 include_directories(api/include)
 add_subdirectory(api)
+include_directories(sdk/include)
+include_directories(sdk)
+add_subdirectory(sdk)
 add_subdirectory(examples)

WORKSPACE

@@ -15,6 +15,29 @@
 workspace(name = "io_opentelemetry_cpp")
 
 load("@bazel_tools//tools/build_defs/repo:http.bzl", "http_archive")
+load("@bazel_tools//tools/build_defs/repo:git.bzl", "new_git_repository")
+
+# Uses older protobuf version because of
+# https://github.com/protocolbuffers/protobuf/issues/7179
+http_archive(
+    name = "com_google_protobuf",
+    sha256 = "b679cef31102ed8beddc39ecfd6368ee311cbee6f50742f13f21be7278781821",
+    strip_prefix = "protobuf-3.11.2",
+    urls = [
+        "https://github.com/protocolbuffers/protobuf/releases/download/v3.11.2/protobuf-all-3.11.2.tar.gz",
+    ],
+)
+
+load("@com_google_protobuf//:protobuf_deps.bzl", "protobuf_deps")
+
+protobuf_deps()
+
+new_git_repository(
+    name = "com_github_opentelemetry_proto",
+    build_file = "//bazel:opentelemetry_proto.BUILD",
+    commit = "d496c80b353bc4a4f754ae686b59ca3c41de0946",
+    remote = "https://github.com/open-telemetry/opentelemetry-proto",
+)
 
 # GoogleTest framework.
 # Only needed for tests, not to build the OpenTelemetry library.

api/include/opentelemetry/plugin/tracer.h

@@ -24,10 +24,6 @@ class Span final : public trace::Span
   {
     span_->AddEvent(name, timestamp);
   }
-  void AddEvent(nostd::string_view name, core::SteadyTimestamp timestamp) noexcept override
-  {
-    span_->AddEvent(name, timestamp);
-  }
 
   void SetStatus(trace::CanonicalCode code, nostd::string_view description) noexcept override
   {

api/include/opentelemetry/trace/noop.h

@@ -26,7 +26,6 @@ class NoopSpan final : public Span
   void AddEvent(nostd::string_view name) noexcept override {}
 
   void AddEvent(nostd::string_view name, core::SystemTimestamp timestamp) noexcept override {}
-  void AddEvent(nostd::string_view name, core::SteadyTimestamp timestamp) noexcept override {}
 
   void SetStatus(CanonicalCode code, nostd::string_view description) noexcept override {}
 

api/include/opentelemetry/trace/span.h

@@ -76,7 +76,6 @@ class Span
 
   // Adds an event to the Span, with a custom timestamp.
   virtual void AddEvent(nostd::string_view name, core::SystemTimestamp timestamp) noexcept = 0;
-  virtual void AddEvent(nostd::string_view name, core::SteadyTimestamp timestamp) noexcept = 0;
 
   // TODO
   // Adds an event to the Span, with a custom timestamp, and attributes.

bazel/opentelemetry_proto.BUILD

@@ -0,0 +1,60 @@
+# 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"])
+
+load("@rules_proto//proto:defs.bzl", "proto_library")
+
+proto_library(
+    name = "common_proto",
+    srcs = glob([
+      "opentelemetry/proto/common/v1/common.proto",
+    ]),
+)
+
+cc_proto_library(
+    name = "common_proto_cc",
+    deps = [":common_proto"],
+)
+
+proto_library(
+    name = "resource_proto",
+    srcs = glob([
+      "opentelemetry/proto/resource/v1/resource.proto",
+    ]),
+    deps = [
+      ":common_proto",
+    ],
+)
+
+cc_proto_library(
+    name = "resource_proto_cc",
+    deps = [":resource_proto"],
+)
+
+proto_library(
+    name = "trace_proto",
+    srcs = glob([
+      "opentelemetry/proto/trace/v1/trace.proto",
+    ]),
+    deps = [
+      ":common_proto",
+      ":resource_proto",
+    ],
+)
+
+cc_proto_library(
+    name = "trace_proto_cc",
+    deps = [":trace_proto"],
+)

ci/Dockerfile

@@ -6,10 +6,12 @@ ADD setup_ci_environment.sh /setup-ci
 ADD setup_cmake.sh /setup-ci
 ADD install_gcc48.sh /setup-ci
 ADD install_bazelisk.sh /setup-ci
+ADD install_protobuf.sh /setup-ci
 ADD install_format_tools.sh /setup-ci
 
 RUN /setup-ci/setup_ci_environment.sh \
   && /setup-ci/setup_cmake.sh \
   && /setup-ci/install_gcc48.sh \
   && /setup-ci/install_bazelisk.sh \
+  && /setup-ci/install_protobuf.sh \
   && /setup-ci/install_format_tools.sh

ci/do_ci.ps1

@@ -38,6 +38,27 @@ switch ($action) {
       exit $exit
     }
   }
+  "cmake.exporter.otprotocol.test" {
+    cd "$BUILD_DIR"
+    cmake $SRC_DIR `
+          -DVCPKG_TARGET_TRIPLET=x64-windows `
+          -DWITH_OTPROTCOL=ON `
+          "-DCMAKE_TOOLCHAIN_FILE=$VCPKG_DIR\scripts\buildsystems\vcpkg.cmake"
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+    cmake --build .
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+    ctest -C Debug
+    $exit = $LASTEXITCODE
+    if ($exit -ne 0) {
+      exit $exit
+    }
+  }
   "cmake.build_example_plugin" {
     cd "$BUILD_DIR"
     cmake $SRC_DIR `

ci/do_ci.sh

@@ -20,6 +20,16 @@ if [[ "$1" == "cmake.test" ]]; then
   make
   make test
   exit 0
+elif [[ "$1" == "cmake.exporter.otprotocol.test" ]]; then
+  cd "${BUILD_DIR}"
+  rm -rf *
+  cmake -DCMAKE_BUILD_TYPE=Debug  \
+        -DWITH_OTPROTOCOL=ON \
+        -DCMAKE_CXX_FLAGS="-Werror" \
+        "${SRC_DIR}"
+  make
+  make test
+  exit 0
 elif [[ "$1" == "cmake.test_example_plugin" ]]; then
   # Build the plugin
   cd "${BUILD_DIR}"

ci/install_protobuf.sh

@@ -0,0 +1,13 @@
+#!/bin/bash
+
+set -e
+
+[ -z "${PROTOBUF_VERSION}" ] && export PROTOBUF_VERSION="3.11.4"
+
+cd /
+wget https://github.com/google/protobuf/releases/download/v${PROTOBUF_VERSION}/protobuf-cpp-${PROTOBUF_VERSION}.tar.gz
+tar zxf protobuf-cpp-${PROTOBUF_VERSION}.tar.gz --no-same-owner
+cd protobuf-${PROTOBUF_VERSION}
+./configure
+make && make install
+ldconfig

ci/setup_ci_environment.sh

@@ -5,4 +5,5 @@ apt-get update
 apt-get install --no-install-recommends --no-install-suggests -y \
                 build-essential \
                 ca-certificates \
-                wget
+                wget \
+                git

ci/setup_windows_ci_environment.ps1

@@ -8,3 +8,4 @@ $VCPKG_DIR=(Get-Item -Path ".\").FullName
 ./vcpkg integrate install
 ./vcpkg install benchmark:x64-windows
 ./vcpkg install gtest:x64-windows
+./vcpkg install protobuf:x64-windows

examples/plugin/plugin/tracer.cc

@@ -26,8 +26,6 @@ class Span final : public trace::Span
 
   void AddEvent(nostd::string_view /*name*/, core::SystemTimestamp /*timestamp*/) noexcept override
   {}
-  void AddEvent(nostd::string_view /*name*/, core::SteadyTimestamp /*timestamp*/) noexcept override
-  {}
 
   void SetStatus(trace::CanonicalCode /*code*/,
                  nostd::string_view /*description*/) noexcept override

sdk/CMakeLists.txt

@@ -0,0 +1,5 @@
+if(WITH_OTPROTOCOL)
+  include(proto/opentelemetry/Protobuf.cmake)
+endif()
+
+add_subdirectory(src)

sdk/proto/opentelemetry/Protobuf.cmake

@@ -0,0 +1,48 @@
+set(PROTO_PATH "${CMAKE_SOURCE_DIR}/sdk/proto")
+
+set(COMMON_PROTO "${PROTO_PATH}/opentelemetry/proto/common/v1/common.proto")
+set(RESOURCE_PROTO "${PROTO_PATH}/opentelemetry/proto/resource/v1/resource.proto")
+set(TRACE_PROTO "${PROTO_PATH}/opentelemetry/proto/trace/v1/trace.proto")
+
+set(GENERATED_PROTOBUF_PATH "${CMAKE_BINARY_DIR}/generated/sdk/proto")
+
+file(MAKE_DIRECTORY "${GENERATED_PROTOBUF_PATH}")
+
+set(COMMON_PB_CPP_FILE "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/common/v1/common.pb.cc")
+set(COMMON_PB_H_FILE "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/common/v1/common.pb.h")
+set(RESOURCE_PB_CPP_FILE "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/resource/v1/resource.pb.cc")
+set(RESOURCE_PB_H_FILE "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/resource/v1/resource.pb.h")
+set(TRACE_PB_CPP_FILE "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/trace/v1/trace.pb.cc")
+set(TRACE_PB_H_FILE "${GENERATED_PROTOBUF_PATH}/opentelemetry/proto/trace/v1/trace.pb.h")
+
+foreach(IMPORT_DIR ${PROTOBUF_IMPORT_DIRS})
+  list(APPEND PROTOBUF_INCLUDE_FLAGS "-I${IMPORT_DIR}")
+endforeach()
+
+add_custom_command(
+  OUTPUT
+    ${COMMON_PB_H_FILE}
+    ${COMMON_PB_CPP_FILE}
+    ${RESOURCE_PB_H_FILE}
+    ${RESOURCE_PB_CPP_FILE}
+    ${TRACE_PB_H_FILE}
+    ${TRACE_PB_CPP_FILE}
+  COMMAND ${PROTOBUF_PROTOC_EXECUTABLE}
+  ARGS
+    "--proto_path=${PROTO_PATH}"
+    ${PROTOBUF_INCLUDE_FLAGS}
+    "--cpp_out=${GENERATED_PROTOBUF_PATH}"
+    ${COMMON_PROTO}
+    ${RESOURCE_PROTO}
+    ${TRACE_PROTO}
+)
+
+include_directories(SYSTEM "${CMAKE_BINARY_DIR}/generated/sdk/proto")
+
+add_library(opentelemetry_proto OBJECT
+    ${COMMON_PB_CPP_FILE}
+    ${RESOURCE_PB_CPP_FILE}
+    ${TRACE_PB_CPP_FILE})
+if (BUILD_SHARED_LIBS)
+  set_property(TARGET opentelemetry_proto PROPERTY POSITION_INDEPENDENT_CODE ON)
+endif()

sdk/proto/opentelemetry/README

@@ -0,0 +1,2 @@
+From: https://github.com/open-telemetry/opentelemetry-proto
+Commit: d496c80b353bc4a4f754ae686b59ca3c41de0946

sdk/proto/opentelemetry/proto/collector/README.md

@@ -0,0 +1,9 @@
+# OpenTelemetry Collector Proto
+
+This package describes the OpenTelemetry collector protocol.
+
+## Packages
+
+1. `common` package contains the common messages shared between different services.
+2. `trace` package contains the Trace Service protos.
+3. `metrics` package contains the Metrics Service protos.

sdk/proto/opentelemetry/proto/collector/metrics/v1/metrics_service.proto

@@ -0,0 +1,45 @@
+// Copyright 2019, 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.
+
+syntax = "proto3";
+
+package opentelemetry.proto.collector.metrics.v1;
+
+import "opentelemetry/proto/metrics/v1/metrics.proto";
+
+option java_multiple_files = true;
+option java_package = "io.opentelemetry.proto.collector.metrics.v1";
+option java_outer_classname = "MetricsServiceProto";
+option go_package = "github.com/open-telemetry/opentelemetry-proto/gen/go/collector/metrics/v1";
+
+// Service that can be used to push metrics between one Application
+// instrumented with OpenTelemetry and a collector, or between a collector and a
+// central collector.
+service MetricsService {
+  // For performance reasons, it is recommended to keep this RPC
+  // alive for the entire life of the application.
+  rpc Export(ExportMetricsServiceRequest) returns (ExportMetricsServiceResponse) {}
+}
+
+message ExportMetricsServiceRequest {
+  // An array of ResourceMetrics.
+  // For data coming from a single resource this array will typically contain one
+  // element. Intermediary nodes (such as OpenTelemetry Collector) that receive
+  // data from multiple origins typically batch the data before forwarding further and
+  // in that case this array will contain multiple elements.
+  repeated opentelemetry.proto.metrics.v1.ResourceMetrics resource_metrics = 1;
+}
+
+message ExportMetricsServiceResponse {
+}