通貨サービス

このサービスは、異なる通貨間で金額を変換する機能を提供します。

通貨サービスのソースコード

トレース

トレースの初期化

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);
 // グローバルトレースプロバイダーを設定する
  opentelemetry::trace::Provider::SetTracerProvider(provider);

 // グローバルプロパゲーターを設定する
  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");

スパンステータスの設定

スパンのステータスを適切に Ok または Error に設定してください。 これは 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
  {
   // サーバーでは不要
  }

  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 の MeterProvidermain() から、meter_common.h で定義された initMeter() 関数を使用して初期化されます。

void initMeter()
{
  // MetricExporter を構築する
  otlp_exporter::OtlpGrpcMetricExporterOptions otlpOptions;
  auto exporter = otlp_exporter::OtlpGrpcMetricExporterFactory::Create(otlpOptions);

  // MeterProvider と 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);
}

IntCounter の開始

グローバル変数 currency_countermain()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 の LoggerProvidermain() から、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 に代入されます。

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

これはコード内でログ出力が必要なときに使用されます。

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