货币服务

此服务提供在不同货币之间转换金额的功能。

货币服务源码

追踪

初始化追踪

OpenTelemetry SDK 从 main 使用 tracer_common.h 中定义的 initTracer 函数进行初始化。

void initTracer()
{
  auto exporter = opentelemetry::exporter::otlp::OtlpGrpcExporterFactory::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::shared_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(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()));
}

创建新跨度

可以使用 Tracer->StartSpan("spanName", attributes, options) 创建和启动新跨度。创建跨度后,需要使用 Tracer->WithActiveSpan(span) 启动并将其置于活动上下文中。您可以在 Convert 函数中找到此示例。

std::string span_name = "CurrencyService/Convert";
auto span =
    get_tracer("currency")->StartSpan(span_name,
                                  {{SemanticConventions::kRpcSystem, "grpc"},
                                   {SemanticConventions::kRpcService, "oteldemo.CurrencyService"},
                                   {SemanticConventions::kRpcMethod, "Convert"},
                                   {SemanticConventions::kRpcGrpcStatusCode, 0}},
                                  options);
auto scope = get_tracer("currency")->WithActiveSpan(span);

向跨度添加属性

您可以使用 Span->SetAttribute(key, value) 向跨度添加属性。

span->SetAttribute("app.currency.conversion.from", from_code);
span->SetAttribute("app.currency.conversion.to", to_code);

添加跨度事件

使用 Span->AddEvent(name) 来添加跨度事件。

span->AddEvent("Conversion successful, response sent back");

设置跨度状态

请确保根据情况将跨度状态设置为 OkError。您可以使用 Span->SetStatus(status) 来执行此操作。

span->SetStatus(StatusCode::kOk);

追踪上下文传播

在 C++ 中,传播不会自动处理。您需要将其从调用者中提取出来,并将传播上下文注入后续的跨度。GrpcServerCarrier 类定义了一个方法来从入站 gRPC 请求中提取上下文,该方法在服务调用实现中得到利用。

GrpcServerCarrier 类定义在 tracer_common.h 中,如下所示:

class GrpcServerCarrier : public opentelemetry::context::propagation::TextMapCarrier
{
public:
  GrpcServerCarrier(ServerContext *context) : context_(context) {}
  GrpcServerCarrier() = default;
  virtual opentelemetry::nostd::string_view Get(
      opentelemetry::nostd::string_view key) const noexcept override
  {
    auto it = context_->client_metadata().find(key.data());
    if (it != context_->client_metadata().end())
    {
      return it->second.data();
    }
    return "";
  }

  virtual void Set(opentelemetry::nostd::string_view key,
                   opentelemetry::nostd::string_view value) noexcept override
  {
   // Not required for server
  }

  ServerContext *context_;
};

该类在 Convert 方法中使用,用于提取上下文并创建一个 StartSpanOptions 对象来包含正确的上下文,该上下文在创建新跨度时使用。

StartSpanOptions options;
options.kind = SpanKind::kServer;
GrpcServerCarrier carrier(context);

auto prop        = context::propagation::GlobalTextMapPropagator::GetGlobalPropagator();
auto current_ctx = context::RuntimeContext::GetCurrent();
auto new_context = prop->Extract(carrier, current_ctx);
options.parent   = GetSpan(new_context)->GetContext();

指标

初始化指标

OpenTelemetry MeterProvider 通过 main() 使用 meter_common.h 中定义的 initMeter() 函数进行初始化。

void initMeter()
{
  // Build MetricExporter
  otlp_exporter::OtlpGrpcMetricExporterOptions otlpOptions;
  auto exporter = otlp_exporter::OtlpGrpcMetricExporterFactory::Create(otlpOptions);

  // Build MeterProvider and Reader
  metric_sdk::PeriodicExportingMetricReaderOptions options;
  std::unique_ptr<metric_sdk::MetricReader> reader{
      new metric_sdk::PeriodicExportingMetricReader(std::move(exporter), options) };
  auto provider = std::shared_ptr<metrics_api::MeterProvider>(new metric_sdk::MeterProvider());
  auto p = std::static_pointer_cast<metric_sdk::MeterProvider>(provider);
  p->AddMetricReader(std::move(reader));
  metrics_api::Provider::SetMeterProvider(provider);
}

启动整数计数器

main() 中创建了一个全局 currency_counter 变量,该变量调用 meter_common.h 中定义的 initIntCounter() 函数。

nostd::unique_ptr<metrics_api::Counter<uint64_t>> initIntCounter()
{
  std::string counter_name = name + "_counter";
  auto provider = metrics_api::Provider::GetMeterProvider();
  nostd::shared_ptr<metrics_api::Meter> meter = provider->GetMeter(name, version);
  auto int_counter = meter->CreateUInt64Counter(counter_name);
  return int_counter;
}

计算货币转换请求

CurrencyCounter() 方法实现如下:

void CurrencyCounter(const std::string& currency_code)
{
    std::map<std::string, std::string> labels = { {"currency_code", currency_code} };
    auto labelkv = common::KeyValueIterableView<decltype(labels)>{ labels };
    currency_counter->Add(1, labelkv);
}

每次调用 Convert() 函数时,都会使用作为 to_code 接收的货币代码来计算转换次数。

CurrencyCounter(to_code);

日志

OpenTelemetry LoggerProvider 通过 main() 使用 logger_common.h 中定义的 initLogger() 函数进行初始化。

void initLogger() {
  otlp::OtlpGrpcLogRecordExporterOptions loggerOptions;
  auto exporter  = otlp::OtlpGrpcLogRecordExporterFactory::Create(loggerOptions);
  auto processor = logs_sdk::SimpleLogRecordProcessorFactory::Create(std::move(exporter));
  std::vector<std::unique_ptr<logs_sdk::LogRecordProcessor>> processors;
  processors.push_back(std::move(processor));
  auto context = logs_sdk::LoggerContextFactory::Create(std::move(processors));
  std::shared_ptr<logs::LoggerProvider> provider = logs_sdk::LoggerProviderFactory::Create(std::move(context));
  opentelemetry::logs::Provider::SetLoggerProvider(provider);
}

使用 LoggerProvider

初始化后的 Logger Provider 在 server.cppmain 中被调用。

logger = getLogger(name);

它将 logger 分配给一个名为 logger 的局部变量。

nostd::shared_ptr<opentelemetry::logs::Logger> logger;

然后,每当我们需要记录一行日志时,都会使用该变量。

logger->Info(std::string(__func__) + " conversion successful");

最后修改于 2025 年 3 月 4 日: [demo] 重命名 demo 服务 (#6438) (ae417344)