货币服务

该服务提供了在不同货币之间进行金额转换的功能。

链路追踪

初始化追踪

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

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);
 // 设置全局追踪提供者
  opentelemetry::trace::Provider::SetTracerProvider(provider);

 // 设置全局传播器
  opentelemetry::context::propagation::GlobalTextMapPropagator::SetGlobalPropagator(
      opentelemetry::nostd::shared_ptr<opentelemetry::context::propagation::TextMapPropagator>(
          new opentelemetry::trace::propagation::HttpTraceContext()));
}

创建新追踪 Span

可以使用 Tracer->StartSpan("spanName", attributes, options) 来创建并启动新的 Span。创建 Span 后，需要使用 Tracer->WithActiveSpan(span) 来启动并将其放入活动上下文中。你可以在 Convert 函数中找到这样的示例。

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

向追踪 Span 添加属性

可以使用 Span->SetAttribute(key, value) 向追踪 Span 添加属性。

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

添加追踪 Span 事件

可以使用 Span->AddEvent(name) 添加追踪 Span 事件。

span->AddEvent("转换成功，返回响应");

设置追踪 Span 状态

确保将追踪 Span 的状态设置为 Ok 或 Error，可以使用 Span->SetStatus(status) 进行设置。

span->SetStatus(StatusCode::kOk);

追踪上下文传播

在 C++ 中，传播不会自动处理，你需要从调用方提取追踪上下文并将传播上下文注入到后续的 Span 中。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
  {
   // 对于服务端来说，无需实现
  }

  ServerContext *context_;
};

在 Convert 方法中，利用这个类提取上下文并创建一个 StartSpanOptions 对象，用于保存正确的上下文，该上下文用于创建新的追踪 Span。

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();

指标

初始化指标

在 main() 函数中，使用 meter_common.h 中定义的 initMeter() 函数初始化 OpenTelemetry 的 MeterProvider。

void initMeter()
{
  // 构建 MetricExporter
  otlp_exporter::OtlpGrpcMetricExporterOptions otlpOptions;

  // 目前不支持通过环境变量进行配置
  otlpOptions.endpoint = "otelcol:4317";
  otlpOptions.aggregation_temporality = metric_sdk::AggregationTemporality::kDelta;
  auto exporter = otlp_exporter::OtlpGrpcMetricExporterFactory::Create(otlpOptions);

  // 构建 MeterProvider 和 Reader
  metric_sdk::PeriodicExportingMetricReaderOptions options;
  options.export_interval_millis = std::chrono::milliseconds(1000);
  options.export_timeout_millis = std::chrono::milliseconds(500);
  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);
}

启动 IntCounter

在 main() 函数中，调用 meter_common.h 中定义的 initIntCounter() 函数来创建全局的 currency_counter 变量。

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);

日志

待定

最后修改 December 10, 2023: translate (a4350d6e)