fix a few build and test issues on Linux

Author: duncanpo

CMakeLists.txt

@@ -126,6 +126,9 @@ if(WIN32)
         ${C_ARES_RUNTIME}
         ${OPENSSL_RUNTIME}
         ${RE2_RUNTIME})
+elseif(UNIX AND NOT APPLE AND NOT CYGWIN)
+    FILE(GLOB OTEL_CPP_RUNTIME ${OPENTELEMETRY_CPP_LIBRARY_DIRS}/*.so)
+    set(OPENTELEMETRY_PROXY_RUNTIME_LIBRARIES ${OTEL_CPP_RUNTIME})
 endif()
 
 # ##############################
@@ -167,6 +170,4 @@ install(DIRECTORY ${TRACE_SDK_MATLAB_SOURCES} DESTINATION .)
 install(DIRECTORY ${OTLP_EXPORTERS_MATLAB_SOURCES} DESTINATION .)
 
 # Install dependent runtime libraries
-if(WIN32)
-    install(FILES ${OPENTELEMETRY_PROXY_RUNTIME_LIBRARIES} DESTINATION +libmexclass/+proxy)
-endif()
+install(FILES ${OPENTELEMETRY_PROXY_RUNTIME_LIBRARIES} DESTINATION +libmexclass/+proxy)

README.md

@@ -2,7 +2,7 @@
 
 MATLAB® interface to [OpenTelemetry™](https://opentelemetry.io/), based on the [OpenTelemetry Specification](https://opentelemetry.io/docs/reference/specification/). OpenTelemetry is an observability framework for creating and managing telemetry data, such as traces, metrics, and logs. This data can then be sent to an observability back-end for monitoring, alerts, and analysis. 
 
-## DISCLAIMERS
+## Status
 - Currently only tracing is supported. Metrics and logs will be in the future.
 - This package is supported and has been tested on Windows® and Linux®. We will add macOS support in the future. 
 
@@ -21,14 +21,7 @@ Installation instructions
 Before proceeding, ensure that the below products are installed:
 * [MATLAB](https://www.mathworks.com/products/matlab.html)
 
-1. Download, build and install [OpenTelemetry C++](https://github.com/open-telemetry/opentelemetry-cpp)
-```
-cd \<opentelemetry-cpp-root>\
-cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_CXX_STANDARD=20 -DWITH_OTLP=TRUE -DWITH_OTLP_HTTP=TRUE -DWITH_OTLP_GRPC=TRUE -DOPENTELEMETRY_INSTALL=ON -DCMAKE_TOOLCHAIN_FILE=\<vcpkg_toolchain_file>\
-cmake --build build --config Release --target ALL_BUILD
-cmake --install build --prefix \<opentelemetry-cpp-installdir>\
-```
-2. Download vcpkg. Install the following packages:
+1. Download [vcpkg](https://vcpkg.io). Install the following packages:
 - abseil
 - c-ares
 - curl
@@ -42,12 +35,19 @@ cmake --install build --prefix \<opentelemetry-cpp-installdir>\
 - gtest
 - benchmark
 
+2. Download, build and install [OpenTelemetry C++](https://github.com/open-telemetry/opentelemetry-cpp)
+```
+cd \<opentelemetry-cpp-root>\
+cmake -S . -B build -DCMAKE_BUILD_TYPE=Release -DCMAKE_POSITION_INDEPENDENT_CODE=ON -DCMAKE_CXX_STANDARD=20 -DWITH_OTLP_HTTP=TRUE -DWITH_OTLP_GRPC=TRUE -DOPENTELEMETRY_INSTALL=ON -DCMAKE_TOOLCHAIN_FILE=\<vcpkg_root>\scripts\buildsystems\vcpkg.cmake
+cmake --build build --config Release --target ALL_BUILD
+cmake --install build --prefix \<opentelemetry-cpp-installdir>\
+```
 3. Download OpenTelemetry MATLAB
 
 4. Build and install OpenTelemetry MATLAB
 ```
 cd \<opentelemetry-matlab-root>\
-cmake -S . -B build -DCMAKE_INSTALL_PREFIX=\<opentelemetry-matlab-installdir>\ -DCMAKE_TOOLCHAIN_FILE=\<vcpkg_toolchain_file> -DCMAKE_PREFIX_PATH=\<path to opentelemetry-cpp-config.cmake>\
+cmake -S . -B build -DCMAKE_INSTALL_PREFIX=\<opentelemetry-matlab-installdir>\ -DCMAKE_TOOLCHAIN_FILE=\<vcpkg_root>\scripts\buildsystems\vcpkg.cmake -DCMAKE_PREFIX_PATH=\<path to opentelemetry-cpp-config.cmake>\
 cmake --build build --config Release --target install
 
 ```
@@ -80,6 +80,12 @@ otelcol --config \<otelcol-config-yaml>\
 ```
 4. If your collector is configured to display the data, you should see your span displayed. 
 
+## Help
+To view documentation of individual function, type "help <function_name>". For example,
+```
+>> help opentelemetry.sdk.trace.TracerProvider
+```
+ 
 ## License
 The license is available in the License file within this repository
 

api/baggage/src/BaggageProxy.cpp

@@ -10,6 +10,8 @@
 
 #include "MatlabDataArray.hpp"
 
+#include <list>
+
 namespace libmexclass::opentelemetry {
 
 libmexclass::proxy::MakeResult BaggageProxy::make(const libmexclass::proxy::FunctionArguments& constructor_arguments) {

test/commonTeardown.m

@@ -3,6 +3,9 @@ function commonTeardown(testCase)
 %
 % Copyright 2023 The MathWorks, Inc.
 
+% Terminate Collector if it is still running
+terminateCollector(testCase);
+
 % On Windows, a command prompt has popped up, remove it as clean up
 if ispc
     system(testCase.TestData.list("cmd") + "  > " + testCase.TestData.pidfile);
@@ -11,5 +14,9 @@ function commonTeardown(testCase)
     system(testCase.TestData.sigterm(pid));
 end
 
-delete(testCase.TestData.jsonfile);
-delete(testCase.TestData.pidfile);
+if exist(testCase.TestData.jsonfile, "file")
+    delete(testCase.TestData.jsonfile);
+end
+if exist(testCase.TestData.pidfile, "file")
+    delete(testCase.TestData.pidfile);
+end

test/readJsonResults.m

@@ -3,25 +3,7 @@
 %
 % Copyright 2023 The MathWorks, Inc.
 
-system(testCase.TestData.list("otelcol") + " > " + testCase.TestData.pidfile);
-
-tbl = testCase.TestData.readlist(testCase.TestData.pidfile);
-pid = testCase.TestData.extractPid(tbl);
-system(testCase.TestData.sigint(pid));
-
-% check if kill succeeded as it can sporadically fail
-system(testCase.TestData.list("otelcol") + " > " + testCase.TestData.pidfile);
-tbl = testCase.TestData.readlist(testCase.TestData.pidfile);
-pid = testCase.TestData.extractPid(tbl);
-retry = 0;
-% sometimes kill will fail with a RuntimeError: windows-kill-library: ctrl-routine:findAddress:checkAddressIsNotNull 
-% in that case, retry up to 3 times
-while ~isempty(pid) && retry < 3
-    system(testCase.TestData.sigint(pid));
-    tbl = testCase.TestData.readlist(testCase.TestData.pidfile);
-    pid = testCase.TestData.extractPid(tbl);
-    retry = retry + 1;
-end
+terminateCollector(testCase);
 
 pause(1);
 assert(exist(testCase.TestData.jsonfile, "file"));

test/tcontextPropagation.m

@@ -38,6 +38,7 @@ function testExtract(testCase)
 tp = opentelemetry.sdk.trace.TracerProvider();
 tr = getTracer(tp, "bar");
 sp = startSpan(tr, "quux", Context=newcontext);
+pause(1);
 endSpan(sp);
 
 % perform test comparisons

test/terminateCollector.m

@@ -0,0 +1,19 @@
+function terminateCollector(testCase)
+% Terminate OpenTelemetry Collector before reading results or as part of
+% cleanup
+%
+% Copyright 2023 The MathWorks, Inc.
+
+system(testCase.TestData.list("otelcol") + " > " + testCase.TestData.pidfile);
+tbl = testCase.TestData.readlist(testCase.TestData.pidfile);
+pid = testCase.TestData.extractPid(tbl);
+retry = 0;
+% sometimes kill will fail with a RuntimeError: windows-kill-library: ctrl-routine:findAddress:checkAddressIsNotNull 
+% Retry up to 3 times
+while ~isempty(pid) && retry < 4
+    system(testCase.TestData.sigint(pid));
+    system(testCase.TestData.list("otelcol") + " > " + testCase.TestData.pidfile);
+    tbl = testCase.TestData.readlist(testCase.TestData.pidfile);
+    pid = testCase.TestData.extractPid(tbl);
+    retry = retry + 1;
+end