-
Notifications
You must be signed in to change notification settings - Fork 3
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #25 from mathworks/changes_after_v_1_3_0
Push examples into metrics
- Loading branch information
Showing
19 changed files
with
696 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,4 @@ | ||
| # build directory | ||
| # build directories | ||
| build | ||
|
|
||
| # Autosave files | ||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
|
|
||
| add_subdirectory(context_propagation) | ||
| add_subdirectory(webread) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,29 @@ | ||
|
|
||
| # C++ target | ||
| set(CONTEXTPROP_EXAMPLE_TARGET contextprop_example_client) | ||
| add_executable(${CONTEXTPROP_EXAMPLE_TARGET} cpp/client.cc) | ||
|
|
||
| target_include_directories(${CONTEXTPROP_EXAMPLE_TARGET} PRIVATE ${OTEL_CPP_PREFIX}/include) | ||
| target_link_libraries(${CONTEXTPROP_EXAMPLE_TARGET} PRIVATE ${OTEL_CPP_LINK_LIBRARIES}) | ||
| if(UNIX AND NOT APPLE AND NOT CYGWIN) | ||
| target_link_options(${CONTEXTPROP_EXAMPLE_TARGET} PRIVATE ${OPENTELEMETRY_PROXY_LINK_OPTIONS}) | ||
| elseif(APPLE) | ||
| set_target_properties(${CONTEXTPROP_EXAMPLE_TARGET} PROPERTIES BUILD_RPATH "${CMAKE_INSTALL_PREFIX}/${LIBMEXCLASS_PROXY_INSTALLED_DIR}") | ||
| endif() | ||
| # use the same C++ standard as OpenTelemetry-cpp | ||
| target_compile_features(${CONTEXTPROP_EXAMPLE_TARGET} PRIVATE cxx_std_${OTEL_CPP_CXX_STANDARD}) | ||
|
|
||
| # MATLAB target | ||
| find_package(Matlab REQUIRED COMPONENTS MCC_COMPILER MAIN_PROGRAM) | ||
|
|
||
| set(CONTEXTPROP_EXAMPLE_DEPLOYNAME mymagic) | ||
| set(CONTEXTPROP_EXAMPLE_MATLAB_SOURCE ${CMAKE_CURRENT_LIST_DIR}/matlab/${CONTEXTPROP_EXAMPLE_DEPLOYNAME}.m) | ||
| set(CONTEXTPROP_EXAMPLE_ROUTES ../../../examples/context_propagation/matlab/routes.json) #somehow, only relative paths are allowed | ||
| matlab_get_version_from_matlab_run(${Matlab_MAIN_PROGRAM} Matlab_LIST_VERSION) | ||
| if(DEFINED Matlab_LIST_VERSION AND ${Matlab_LIST_VERSION} VERSION_GREATER_EQUAL 23.2.0) | ||
| # since MATLAB R2023b, route mapping can be specified at the archive level | ||
| set(ARCHIVE_ROUTES ",ROUTES:${CONTEXTPROP_EXAMPLE_ROUTES}") | ||
| else() | ||
| set(ARCHIVE_ROUTES "") | ||
| endif() | ||
| install(CODE "execute_process(COMMAND ${Matlab_MCC_COMPILER} -W CTF:${CONTEXTPROP_EXAMPLE_DEPLOYNAME}${ARCHIVE_ROUTES} -U ${CONTEXTPROP_EXAMPLE_MATLAB_SOURCE} -a ${CMAKE_INSTALL_PREFIX} -a ${CMAKE_INSTALL_PREFIX}/+libmexclass/+proxy WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR})") |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| # Context Propagation Example | ||
|
|
||
| In this example, a C++ client calls a MATLAB function hosted on MATLAB Production Server that returns a magic square matrix. Both the C++ client and the MATLAB code are instrumented with OpenTelemetry, and their generated spans form a single trace. | ||
|
|
||
| ## Building the Example | ||
| 1. Enable WITH_EXAMPLES when building OpenTelemetry-Matlab | ||
| ``` | ||
| cmake -S . -B build -DWITH_EXAMPLES=ON -DCMAKE_INSTALL_PREFIX=<opentelemetry-matlab-installdir> | ||
| cmake --build build --config Release | ||
| ``` | ||
| The built examples can be found in build/examples/context_propagation and subdirectories. | ||
| 2. [Create](https://www.mathworks.com/help/mps/server/creating-a-server.html) and [start](https://www.mathworks.com/help/mps/qs/starting-and-stopping.html) a MATLAB Production Server instance. | ||
| 3. [Deploy](https://www.mathworks.com/help/mps/qs/share-a-ctf-archive-on-the-server-instance.html) archive to server instance by copying to the auto_deploy directory. | ||
| 4. If using a MATLAB release before R2023b, [copy](https://www.mathworks.com/help/mps/server/use-web-handler-for-custom-routes-and-custom-payloads.html) matlab/routes.json to the config directory of the server instance. | ||
| 6. Start an instance of [OpenTelemetry Collector](https://github.com/open-telemetry/opentelemetry-collector). | ||
| 7. Start the C++ client. | ||
| ``` | ||
| cd cpp/build/Release | ||
| http_client | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| // Copyright 2023 The MathWorks, Inc. | ||
|
|
||
| #pragma once | ||
|
|
||
| #include <string> | ||
| #include "opentelemetry/nostd/string_view.h" | ||
| #include "opentelemetry/trace/propagation/http_trace_context.h" | ||
|
|
||
| namespace | ||
| { | ||
|
|
||
| template <typename T> | ||
| class HttpTextMapCarrier : public opentelemetry::context::propagation::TextMapCarrier | ||
| { | ||
| public: | ||
| HttpTextMapCarrier(T &headers) : headers_(headers) {} | ||
| HttpTextMapCarrier() = default; | ||
| virtual opentelemetry::nostd::string_view Get( | ||
| opentelemetry::nostd::string_view key) const noexcept override | ||
| { | ||
| std::string key_to_compare = key.data(); | ||
| auto it = headers_.find(key_to_compare); | ||
| if (it != headers_.end()) | ||
| { | ||
| return it->second; | ||
| } | ||
| return ""; | ||
| } | ||
|
|
||
| virtual void Set(opentelemetry::nostd::string_view key, | ||
| opentelemetry::nostd::string_view value) noexcept override | ||
| { | ||
| headers_.insert(std::pair<std::string, std::string>(std::string(key), std::string(value))); | ||
| } | ||
|
|
||
| T headers_; | ||
| }; | ||
|
|
||
| } // namespace |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| // Copyright 2023 The MathWorks, Inc. | ||
|
|
||
| #include "opentelemetry/ext/http/client/http_client_factory.h" | ||
| #include "opentelemetry/ext/http/common/url_parser.h" | ||
| #include "opentelemetry/trace/semantic_conventions.h" | ||
| #include "HttpTextMapCarrier.h" | ||
|
|
||
| #include "opentelemetry/exporters/otlp/otlp_http_exporter_factory.h" | ||
| #include "opentelemetry/sdk/trace/simple_processor_factory.h" | ||
| #include "opentelemetry/sdk/trace/tracer_context.h" | ||
| #include "opentelemetry/sdk/trace/tracer_context_factory.h" | ||
| #include "opentelemetry/sdk/trace/tracer_provider_factory.h" | ||
| #include "opentelemetry/trace/provider.h" | ||
|
|
||
| #include "opentelemetry/context/propagation/global_propagator.h" | ||
| #include "opentelemetry/context/propagation/text_map_propagator.h" | ||
|
|
||
| #include <vector> | ||
| #include "opentelemetry/ext/http/client/http_client.h" | ||
| #include "opentelemetry/nostd/shared_ptr.h" | ||
|
|
||
| namespace | ||
| { | ||
|
|
||
| using namespace opentelemetry::trace; | ||
| namespace http_client = opentelemetry::ext::http::client; | ||
| namespace context = opentelemetry::context; | ||
| namespace nostd = opentelemetry::nostd; | ||
|
|
||
| void InitTracer() | ||
| { | ||
| auto exporter = opentelemetry::exporter::otlp::OtlpHttpExporterFactory::Create(); | ||
| auto processor = | ||
| opentelemetry::sdk::trace::SimpleSpanProcessorFactory::Create(std::move(exporter)); | ||
| std::vector<std::unique_ptr<opentelemetry::sdk::trace::SpanProcessor>> processors; | ||
| processors.push_back(std::move(processor)); | ||
| std::unique_ptr<opentelemetry::sdk::trace::TracerContext> context = | ||
| opentelemetry::sdk::trace::TracerContextFactory::Create(std::move(processors)); | ||
| std::shared_ptr<opentelemetry::trace::TracerProvider> provider = | ||
| opentelemetry::sdk::trace::TracerProviderFactory::Create(std::move(context)); | ||
| // Set the global trace provider | ||
| opentelemetry::trace::Provider::SetTracerProvider(provider); | ||
|
|
||
| // set global propagator | ||
| opentelemetry::context::propagation::GlobalTextMapPropagator::SetGlobalPropagator( | ||
| opentelemetry::nostd::shared_ptr<opentelemetry::context::propagation::TextMapPropagator>( | ||
| new opentelemetry::trace::propagation::HttpTraceContext())); | ||
| } | ||
|
|
||
| opentelemetry::nostd::shared_ptr<opentelemetry::trace::Tracer> get_tracer(std::string tracer_name) | ||
| { | ||
| auto provider = opentelemetry::trace::Provider::GetTracerProvider(); | ||
| return provider->GetTracer(tracer_name); | ||
| } | ||
|
|
||
| void sendRequest(const std::string &url) | ||
| { | ||
| auto http_client = http_client::HttpClientFactory::CreateSync(); | ||
| // define input to post to destination | ||
| std::vector<uint8_t> body; | ||
| uint8_t magic_square_size = 3; // request 3x3 magic square | ||
| body.push_back(magic_square_size); | ||
|
|
||
| // start active span | ||
| StartSpanOptions options; | ||
| options.kind = SpanKind::kClient; // client | ||
| opentelemetry::ext::http::common::UrlParser url_parser(url); | ||
|
|
||
| std::string span_name = url_parser.path_; | ||
| auto span = get_tracer("http-client") | ||
| ->StartSpan(span_name, | ||
| {{SemanticConventions::kUrlFull, url_parser.url_}, | ||
| {SemanticConventions::kUrlScheme, url_parser.scheme_}, | ||
| {SemanticConventions::kHttpRequestMethod, "POST"}}, | ||
| options); | ||
| auto scope = get_tracer("http-client")->WithActiveSpan(span); | ||
|
|
||
| // inject current context into http header | ||
| auto current_ctx = context::RuntimeContext::GetCurrent(); | ||
| HttpTextMapCarrier<http_client::Headers> carrier; | ||
| auto prop = context::propagation::GlobalTextMapPropagator::GetGlobalPropagator(); | ||
| prop->Inject(carrier, current_ctx); | ||
|
|
||
| // send http request | ||
| http_client::Result result = http_client->Post(url, body, carrier.headers_); | ||
| if (result) | ||
| { | ||
| // set span attributes | ||
| auto status_code = result.GetResponse().GetStatusCode(); | ||
| span->SetAttribute(SemanticConventions::kHttpResponseStatusCode, status_code); | ||
| result.GetResponse().ForEachHeader( | ||
| [&span](nostd::string_view header_name, nostd::string_view header_value) { | ||
| span->SetAttribute("http.header." + std::string(header_name.data()), header_value); | ||
| return true; | ||
| }); | ||
|
|
||
| if (status_code >= 400) | ||
| { | ||
| span->SetStatus(StatusCode::kError); | ||
| } | ||
| } | ||
| else | ||
| { | ||
| span->SetStatus( | ||
| StatusCode::kError, | ||
| "Response Status :" + | ||
| std::to_string( | ||
| static_cast<typename std::underlying_type<http_client::SessionState>::type>( | ||
| result.GetSessionState()))); | ||
| } | ||
| // end span and export data | ||
| span->End(); | ||
| } | ||
|
|
||
| void CleanupTracer() | ||
| { | ||
| std::shared_ptr<opentelemetry::trace::TracerProvider> none; | ||
| opentelemetry::trace::Provider::SetTracerProvider(none); | ||
| } | ||
|
|
||
| } // namespace | ||
|
|
||
| int main(int argc, char *argv[]) | ||
| { | ||
| InitTracer(); | ||
| constexpr char default_host[] = "localhost"; | ||
| constexpr char default_path[] = "/mymagic/magic"; | ||
| constexpr uint16_t default_port = 9910; | ||
| uint16_t port; | ||
|
|
||
| // The port the validation service listens to can be specified via the command line. | ||
| if (argc > 1) | ||
| { | ||
| port = (uint16_t)(atoi(argv[1])); | ||
| } | ||
| else | ||
| { | ||
| port = default_port; | ||
| } | ||
|
|
||
| std::string url = "http://" + std::string(default_host) + ":" + std::to_string(port) + | ||
| std::string(default_path); | ||
| sendRequest(url); | ||
| CleanupTracer(); | ||
| } |
Oops, something went wrong.