Konfigurowanie podstawowej wtyczki OpenTelemetry w gRPC C++

1. Wprowadzenie

W tym ćwiczeniu dowiesz się, jak za pomocą gRPC utworzyć klienta i serwer, które będą stanowić podstawę aplikacji do mapowania tras napisanej w C++.

Po ukończeniu tego samouczka będziesz mieć prostą aplikację gRPC HelloWorld wyposażoną we wtyczkę gRPC OpenTelemetry i będziesz w stanie wyświetlać wyeksportowane dane dostrzegalności w Prometheusie.

Czego się nauczysz

• Jak skonfigurować wtyczkę OpenTelemetry w istniejącej aplikacji gRPC C++
• Uruchamianie lokalnej instancji Prometheusa
• Eksportowanie danych do Prometheusa
• Wyświetlanie danych z panelu Prometheusa

2. Zanim zaczniesz

Czego potrzebujesz

• git
• curl
• build-essential
• clang
• bazel do tworzenia przykładów w tym ćwiczeniu

Zainstaluj wstępnie wymagane usługi:

sudo apt-get update -y
sudo apt-get upgrade -y
sudo apt-get install -y git curl build-essential clang

bazel można zainstalować za pomocą bazelisk. Najnowszą wersję znajdziesz tutaj.

Prostym sposobem na skonfigurowanie jest zainstalowanie go jako pliku binarnego bazel w ścieżce PATH w ten sposób:

sudo cp bazelisk-linux-amd64 /usr/local/bin/bazel
sudo chmod a+x /usr/local/bin/bazel

Możesz też użyć CMake. Instrukcje korzystania z CMake znajdziesz tutaj.

Pobierz kod

W tym ćwiczeniu znajdziesz gotowy szkielet kodu źródłowego, który pomoże Ci zacząć i w ten sposób ułatwi Ci naukę. Z podanych niżej instrukcji dowiesz się, jak zintegrować wtyczkę gRPC OpenTelemetry z aplikacją.

grpc-codelabs

Kod źródłowy szkieletu tego ćwiczenia jest dostępny w tym katalogu na GitHubie. Jeśli nie chcesz samodzielnie implementować kodu, gotowy kod źródłowy znajdziesz w katalogu completed.

Najpierw sklonuj repozytorium ćwiczeń z programowania gRPC i przejdź do folderu grpc-cpp-opentelemetry:

git clone -b v1 https://github.com/grpc-ecosystem/grpc-codelabs.git
cd grpc-codelabs/codelabs/grpc-cpp-opentelemetry/

Możesz też pobrać plik ZIP zawierający tylko katalog z ćwiczeniem i rozpakować go ręcznie.

Pobierz ZIP

Utwórz bibliotekę gRPC za pomocą bazel:

bazel build start_here/...

Uwaga: tworzenie gRPC może potrwać kilka minut. W międzyczasie możemy przejść do następnego kroku, aby wyposażyć nasz przykład gRPC we wtyczkę gRPC OpenTelemetry.

3. Rejestrowanie wtyczki OpenTelemetry

Aby dodać wtyczkę gRPC OpenTelemetry, potrzebujemy aplikacji gRPC. W tym ćwiczeniu użyjemy prostego klienta i serwera gRPC HelloWorld, które wyposażymy we wtyczkę gRPC OpenTelemetry.

Najpierw zarejestruj w kliencie wtyczkę OpenTelemetry skonfigurowaną z eksporterem Prometheusa. Otwórz codelabs/grpc-cpp-opentelemetry/start_here/greeter_callback_client.cc w ulubionym edytorze i zmień main() tak, aby wyglądał tak:

int main(int argc, char **argv) {
  absl::ParseCommandLine(argc, argv);

  // Codelab Solution: Register a global gRPC OpenTelemetry plugin configured
  // with a prometheus exporter.
  opentelemetry::exporter::metrics::PrometheusExporterOptions opts;
  opts.url = absl::GetFlag(FLAGS_prometheus_endpoint);
  auto prometheus_exporter =
      opentelemetry::exporter::metrics::PrometheusExporterFactory::Create(opts);
  auto meter_provider =
      std::make_shared<opentelemetry::sdk::metrics::MeterProvider>();

  // The default histogram boundaries are not granular enough for RPCs. Override
  // the "grpc.client.attempt.duration" view as recommended by
  // https://github.com/grpc/proposal/blob/master/A66-otel-stats.md.
  AddLatencyView(meter_provider.get(), "grpc.client.attempt.duration", "s");
  meter_provider->AddMetricReader(std::move(prometheus_exporter));
  auto status = grpc::OpenTelemetryPluginBuilder()
                    .SetMeterProvider(std::move(meter_provider))
                    .BuildAndRegisterGlobal();
  if (!status.ok()) {
    std::cerr << "Failed to register gRPC OpenTelemetry Plugin: "
              << status.ToString() << std::endl;
    return static_cast<int>(status.code());
  }

  // Continuously send RPCs.
  RunClient(absl::GetFlag(FLAGS_target));

  return 0;
}

Uwaga: eksporter Prometheusa jest konfigurowany w usłudze OpenTelemetry Meter Provider. (Dane możesz też wyeksportować w inny sposób. W tym laboratorium wybieramy eksporter Prometheusa). Ten obiekt MeterProvider jest przekazywany do wtyczki OpenTelemetry gRPC jako konfiguracja. Gdy wtyczka OpenTelemetry zostanie zarejestrowana globalnie, wszystkie klienty i serwery gRPC będą instrumentowane za pomocą OpenTelemetry.

Następnym krokiem jest dodanie wtyczki OpenTelemetry do serwera. Otwórz codelabs/grpc-cpp-opentelemetry/start_here/greeter_callback_server.cc i zmień main tak, aby wyglądał tak:

int main(int argc, char** argv) {
  absl::ParseCommandLine(argc, argv);

  // Register a global gRPC OpenTelemetry plugin configured with a prometheus
  // exporter.
  opentelemetry::exporter::metrics::PrometheusExporterOptions opts;
  opts.url = absl::GetFlag(FLAGS_prometheus_endpoint);
  auto prometheus_exporter =
      opentelemetry::exporter::metrics::PrometheusExporterFactory::Create(opts);
  auto meter_provider =
      std::make_shared<opentelemetry::sdk::metrics::MeterProvider>();

  // The default histogram boundaries are not granular enough for RPCs. Override
  // the "grpc.server.call.duration" view as recommended by
  // https://github.com/grpc/proposal/blob/master/A66-otel-stats.md.
  AddLatencyView(meter_provider.get(), "grpc.server.call.duration", "s");
  meter_provider->AddMetricReader(std::move(prometheus_exporter));
  auto status = grpc::OpenTelemetryPluginBuilder()
                    .SetMeterProvider(std::move(meter_provider))
                    .BuildAndRegisterGlobal();
  if (!status.ok()) {
    std::cerr << "Failed to register gRPC OpenTelemetry Plugin: "
              << status.ToString() << std::endl;
    return static_cast<int>(status.code());
  }
  RunServer(absl::GetFlag(FLAGS_port));
  return 0;
}

Wymagane pliki nagłówkowe i zależności kompilacji zostały już dodane dla wygody.

#include "opentelemetry/exporters/prometheus/exporter_factory.h"
#include "opentelemetry/exporters/prometheus/exporter_options.h"
#include "opentelemetry/sdk/metrics/meter_provider.h"

#include <grpcpp/ext/otel_plugin.h>

Zależności kompilacji są też już dodane w pliku BUILD:

cc_binary(
    name = "greeter_callback_client",
    srcs = ["greeter_callback_client.cc"],
    defines = ["BAZEL_BUILD"],
    deps = [
        "//util:util",
        "@com_github_grpc_grpc//:grpc++",
        "@com_github_grpc_grpc//:grpcpp_otel_plugin",
        "@com_google_absl//absl/flags:flag",
        "@com_google_absl//absl/flags:parse",
        "@io_opentelemetry_cpp//exporters/prometheus:prometheus_exporter",
        "@io_opentelemetry_cpp//sdk/src/metrics",
    ],
)

4. Uruchamianie przykładu i wyświetlanie danych

Aby uruchomić serwer, wpisz:

bazel run start_here:greeter_callback_server

Jeśli konfiguracja się powiedzie, zobaczysz na serwerze ten wynik:

Server listening on 0.0.0.0:50051

Gdy serwer jest uruchomiony, w innym terminalu uruchom klienta:

bazel run start_here:greeter_callback_client

Pomyślne uruchomienie będzie wyglądać tak:

Greeter received: Hello world
Greeter received: Hello world
Greeter received: Hello world
Greeter received: Hello world
Greeter received: Hello world
Greeter received: Hello world
Greeter received: Hello world
Greeter received: Hello world
Greeter received: Hello world
Greeter received: Hello world
Greeter received: Hello world

Skonfigurowaliśmy wtyczkę gRPC OpenTelemetry do eksportowania wskaźników za pomocą Prometheusa. Te dane będą dostępne na serwerze localhost:9464 i na kliencie localhost:9465.

Aby wyświetlić dane klienta:

curl localhost:9465/metrics

Wynik będzie mieć postać:

# HELP exposer_transferred_bytes_total Transferred bytes to metrics services
# TYPE exposer_transferred_bytes_total counter
exposer_transferred_bytes_total 0
# HELP exposer_scrapes_total Number of times metrics were scraped
# TYPE exposer_scrapes_total counter
exposer_scrapes_total 0
# HELP exposer_request_latencies Latencies of serving scrape requests, in microseconds
# TYPE exposer_request_latencies summary
exposer_request_latencies_count 0
exposer_request_latencies_sum 0
exposer_request_latencies{quantile="0.5"} Nan
exposer_request_latencies{quantile="0.9"} Nan
exposer_request_latencies{quantile="0.99"} Nan
# HELP target Target metadata
# TYPE target gauge
target_info{otel_scope_name="grpc-c++",otel_scope_version="1.67.0-dev",service_name="unknown_service",telemetry_sdk_version="1.13.0",telemetry_sdk_name="opentelemetry",telemetry_sdk_language="cpp"} 1 1721958543107
# HELP grpc_client_attempt_rcvd_total_compressed_message_size_bytes Compressed message bytes received per call attempt
# TYPE grpc_client_attempt_rcvd_total_compressed_message_size_bytes histogram
grpc_client_attempt_rcvd_total_compressed_message_size_bytes_count{grpc_method="helloworld.Greeter/SayHello",grpc_status="OK",grpc_target="dns:///localhost:50051",otel_scope_name="grpc-c++",otel_scope_version="1.67.0-dev"} 96 1721958543107
grpc_client_attempt_rcvd_total_compressed_message_size_bytes_sum{grpc_method="helloworld.Greeter/SayHello",grpc_status="OK",grpc_target="dns:///localhost:50051",otel_scope_name="grpc-c++",otel_scope_version="1.67.0-dev"} 1248 1721958543107
grpc_client_attempt_rcvd_total_compressed_message_size_bytes_bucket{grpc_method="helloworld.Greeter/SayHello",grpc_status="OK",grpc_target="dns:///localhost:50051",otel_scope_name="grpc-c++",otel_scope_version="1.67.0-dev",le="0"} 0 1721958543107
grpc_client_attempt_rcvd_total_compressed_message_size_bytes_bucket{grpc_method="helloworld.Greeter/SayHello",grpc_status="OK",grpc_target="dns:///localhost:50051",otel_scope_name="grpc-c++",otel_scope_version="1.67.0-dev",le="5"} 0 1721958543107
grpc_client_attempt_rcvd_total_compressed_message_size_bytes_bucket{grpc_method="helloworld.Greeter/SayHello",grpc_status="OK",grpc_target="dns:///localhost:50051",otel_scope_name="grpc-c++",otel_scope_version="1.67.0-dev",le="10"} 0 1721958543107
grpc_client_attempt_rcvd_total_compressed_message_size_bytes_bucket{grpc_method="helloworld.Greeter/SayHello",grpc_status="OK",grpc_target="dns:///localhost:50051",otel_scope_name="grpc-c++",otel_scope_version="1.67.0-dev",le="25"} 96 1721958543107
grpc_client_attempt_rcvd_total_compressed_message_size_bytes_bucket{grpc_method="helloworld.Greeter/SayHello",grpc_status="OK",grpc_target="dns:///localhost:50051",otel_scope_name="grpc-c++",otel_scope_version="1.67.0-dev",le="50"} 96 1721958543107
grpc_client_attempt_rcvd_total_compressed_message_size_bytes_bucket{grpc_method="helloworld.Greeter/SayHello",grpc_status="OK",grpc_target="dns:///localhost:50051",otel_scope_name="grpc-c++",otel_scope_version="1.67.0-dev",le="75"} 96 1721958543107

Podobnie w przypadku danych po stronie serwera:

curl localhost:9464/metrics

5. Wyświetlanie danych w Prometheusie

W tym ćwiczeniu skonfigurujemy instancję Prometheusa, która będzie pobierać dane z naszego przykładowego klienta i serwera gRPC, które eksportują dane za pomocą Prometheusa.

Pobierz najnowszą wersję Prometheusa na swoją platformę, a następnie rozpakuj ją i uruchom:

tar xvfz prometheus-*.tar.gz
cd prometheus-*

Utwórz plik konfiguracyjny Prometheusa z tymi treściami:

cat > grpc_otel_cpp_prometheus.yml <<EOF
scrape_configs:
  - job_name: "prometheus"
    scrape_interval: 5s
    static_configs:
      - targets: ["localhost:9090"]
  - job_name: "grpc-otel-cpp"
    scrape_interval: 5s
    static_configs:
      - targets: ["localhost:9464", "localhost:9465"]
EOF

Uruchom Prometheusa z nową konfiguracją:

./prometheus --config.file=grpc_otel_cpp_prometheus.yml

Spowoduje to skonfigurowanie wskaźników klienta i serwera z procesów zainicjowanych w ćwiczeniu tak, aby były pobierane co 5 sekund.

Aby wyświetlić wartości wskaźników, otwórz stronę http://localhost:9090/graph. Na przykład zapytanie

histogram_quantile(0.5, rate(grpc_client_attempt_duration_seconds_bucket[1m]))

wyświetli wykres z medianą czasu oczekiwania na próby z 1-minutowym oknem czasowym do obliczania kwantyla.

Częstotliwość zapytań:

increase(grpc_client_attempt_duration_seconds_bucket[1m])

6. (Opcjonalne) Ćwiczenie dla użytkownika

W panelach Prometheusa zauważysz, że ilość zapytań/s jest niska. Sprawdź, czy w przykładzie możesz znaleźć podejrzany kod, który ogranicza liczbę zapytań na sekundę.

Uwaga dla entuzjastów: kod klienta ogranicza się do jednego oczekującego wywołania RPC w danym momencie. Można to zmodyfikować tak, aby klient wysyłał więcej wywołań RPC bez czekania na zakończenie poprzednich. (Rozwiązanie tego problemu nie zostało podane).