通过OpenTelemetry接入Qt Trace数据

前提条件

• 已创建Trace实例。具体操作，请参见创建Trace实例。

• 已准备相关的开发环境，该环境需要支持编译和运行OpenTelemetry C++ SDK。

  • 如果您使用的是CMake编译器，则其版本需为3.1及以上（建议）。

  • 如果您使用的是GCC或G++编译器，则其版本需要为4.8及以上。

  • 如果您使用的是MSVC，则其版本需要为VS2015及以上（建议为VS2019）。

• 支持的C++版本如下所示。

  • ISO/IEC 14882:2011（C++11, C++0x）

  • ISO/IEC 14882:2014（C++14, C++1y）

  • ISO/IEC 14882:2017（C++17, C++1z）

  • ISO/IEC 14882:2020（C++20）

• 已安装Git版本控制工具。

• 更多依赖及版本信息，请参见opentelemetry-cpp。

步骤一：配置Visual Studio

为了使OpenTelemetry C++ SDK与Qt项目一起编译，需要将Qt的编译工具切换为MSVC，即需要在Visual Studio中安装Qt Visual Studio Tools插件。

1. 在Visual Studio顶部菜单栏中，选择扩展>管理扩展，然后搜索Qt Visual Studio Tools。

2. 单击Qt Visual Studio Tools对应的下载。

3. 待插件下载完成后，关闭Visual Studio的所有窗口。

4. 在自动弹出的VSIX Installer对话框中，单击Modify，插件会自动完成安装。

5. 确认插件安装完成。

   重新打开Visual Studio项目，如果扩展菜单下有Qt VS Tools选项，则表示Qt Visual Studio Tools插件安装成功。

关于Qt Visual Studio Tools的更多信息，请参见Qt Visual Studio Tools。

步骤二：集成SDK

opentelemetry-cpp项目的构建编译依赖CMake工具，即需要将Qt的编译构建工具切换为CMake。本文以opentelemetry-cpp 1.9.0版本为例。

步骤三：接入验证

1. 在Qt项目中加入以下代码，然后运行项目。

   #include "mainwindow.h"
   
   #include <QApplication>
   
   #include "opentelemetry/exporters/ostream/span_exporter_factory.h"
   #include "opentelemetry/exporters/otlp/otlp_http.h"
   #include "opentelemetry/exporters/otlp/otlp_http_exporter_factory.h"
   #include "opentelemetry/exporters/otlp/otlp_http_exporter_options.h"
   #include "opentelemetry/sdk/trace/simple_processor_factory.h"
   #include "opentelemetry/sdk/trace/tracer_provider_factory.h"
   #include "opentelemetry/trace/provider.h"
   #include "opentelemetry/sdk/trace/tracer_provider.h"
   
   #include "opentelemetry/sdk/version/version.h"
   #include "opentelemetry/trace/provider.h"
   #include "opentelemetry/sdk/resource/resource.h"
   #include "opentelemetry/sdk/resource/semantic_conventions.h"
   
   #include "opentelemetry/sdk/common/global_log_handler.h"
   
   
   
   namespace trace = opentelemetry::trace;
   namespace trace_sdk = opentelemetry::sdk::trace;
   namespace otlp = opentelemetry::exporter::otlp;
   namespace trace_exporter = opentelemetry::exporter::trace;
   namespace resource = opentelemetry::sdk::resource;
   
   namespace
   {
       opentelemetry::exporter::otlp::OtlpHttpExporterOptions opts;
       void InitTracer()
       {
           opts.url = "https://<your project>.<your endpoint>/opentelemetry/v1/traces";
           opts.console_debug = true;
           opts.content_type = otlp::HttpRequestContentType::kBinary;
           // Setup credentials info
           opts.http_headers.insert(std::pair<std::string, std::string>("x-sls-otel-project", "<your project>"));
           opts.http_headers.insert(std::pair<std::string, std::string>("x-sls-otel-instance-id", "<your instanceId>"));
           opts.http_headers.insert(std::pair<std::string, std::string>("x-sls-otel-ak-id", "<your accesskey id>"));
           opts.http_headers.insert(std::pair<std::string, std::string>("x-sls-otel-ak-secret", "<your accesskey secret>"));
   
           // Create OTLP exporter instance
           auto exporter = otlp::OtlpHttpExporterFactory::Create(opts);
           auto processor = trace_sdk::SimpleSpanProcessorFactory::Create(std::move(exporter));
   
           resource::ResourceAttributes attributes = {
             {resource::SemanticConventions::kServiceName, "test"},
             {resource::SemanticConventions::kServiceNamespace, "OTelExample4QT"},
             {resource::SemanticConventions::kServiceVersion, "1.0.0"},
             {resource::SemanticConventions::kHostName, "Win64"},
             {resource::SemanticConventions::kDeploymentEnvironment, "dev"}
           };
           auto resource = opentelemetry::sdk::resource::Resource::Create(attributes);
   
           std::shared_ptr<opentelemetry::trace::TracerProvider> provider =
               trace_sdk::TracerProviderFactory::Create(std::move(processor), std::move(resource));
           // Set the global trace provider
           trace::Provider::SetTracerProvider(provider); 
       }
   
       void CleanupTracer()
       {
           // We call ForceFlush to prevent to cancel running exportings, It's optional.
           opentelemetry::nostd::shared_ptr<opentelemetry::trace::TracerProvider> provider =
               trace::Provider::GetTracerProvider();
           if (provider)
           {
               static_cast<trace_sdk::TracerProvider*>(provider.get())->ForceFlush();
           }
   
           std::shared_ptr<opentelemetry::trace::TracerProvider> none;
           trace::Provider::SetTracerProvider(none);
       }
   }  // namespace
   
   namespace trace = opentelemetry::trace;
   namespace nostd = opentelemetry::nostd;
   
   namespace
   {
       nostd::shared_ptr<trace::Tracer> get_tracer()
       {
           auto provider = trace::Provider::GetTracerProvider();
           return provider->GetTracer("foo_library", OPENTELEMETRY_SDK_VERSION);
       }
   
       void basic_f1()
       {
           auto span = get_tracer()->StartSpan("basic_f1");
           // do your stuff
           // ...
           span->End();
       }
   
       void basic_f1_with_attributes()
       {
           auto span = get_tracer()->StartSpan("basic_f1_with_attributes");
           span->SetAttribute("ags", 12);
           span->SetAttribute("sex", "man");
           span->SetAttribute("height", 154.5);
   
   
           span->AddEvent("message: success");
   
           span->SetStatus(trace::StatusCode::kError);
   
           span->End();
       }
   
       void basic_active_f1()
       {
           auto span_child = get_tracer()->StartSpan("operation B");
           // do your stuff
           // ...
           span_child->End();
       }
   
       void basic_active()
       {
           auto span = get_tracer()->StartSpan("operation A");
           auto scope = get_tracer()->WithActiveSpan(span);
   
           basic_active_f1();
   
           span->End();
       }
   
   
       void f1()
       {
           auto scoped_span = trace::Scope(get_tracer()->StartSpan("f1"));
       }
   
       void f2()
       {
           auto scoped_span = trace::Scope(get_tracer()->StartSpan("f2"));
   
           f1();
           f1();
       }
   }  // namespace
   
   void foo_library()
   {
   
       basic_f1();
       basic_active();
       basic_f1_with_attributes();
   
       auto scoped_span = trace::Scope(get_tracer()->StartSpan("library"));
   
       f2();
   
   }
   
   int main(int argc, char *argv[])
   {
       QApplication a(argc, argv);
       MainWindow w;
       w.show();
   
       InitTracer();
   
       foo_library();
   
       CleanupTracer();
   
       return a.exec();
   }
   

2. 在日志服务控制台的Trace服务应用中，查看Trace数据。

   添加过滤条件service : "test"，查看已接入的Qt Trace数据。