Cloud Profiler API C++ Client Library

An idiomatic C++ client library for the Cloud Profiler API, a service that manages continuous CPU and heap profiling to improve performance and reduce costs.

Note that this library allows you to interact with Cloud Profiler, but Cloud Profiler does not yet offer profiling of C++ applications. The types of profiling available are listed in the service documentation.

While this library is GA, please note Google Cloud C++ client libraries do not follow Semantic Versioning.

Quickstart

The following shows the code that you'll run in the google/cloud/profiler/quickstart/ directory, which should give you a taste of the Cloud Profiler API C++ client library API.

#include "google/cloud/profiler/v2/profiler_client.h"
#include "google/cloud/project.h"
#include <iostream>

int main(int argc, char* argv[]) try {
  if (argc != 2) {
    std::cerr << "Usage: " << argv[0] << " project-id\n";
    return 1;
  }

  namespace profiler = ::google::cloud::profiler_v2;
  auto client = profiler::ProfilerServiceClient(
      profiler::MakeProfilerServiceConnection());

  google::devtools::cloudprofiler::v2::CreateProfileRequest req;
  req.set_parent(google::cloud::Project(argv[1]).FullName());
  req.add_profile_type(google::devtools::cloudprofiler::v2::CPU);
  auto& deployment = *req.mutable_deployment();
  deployment.set_project_id(argv[1]);
  deployment.set_target("quickstart");

  auto profile = client.CreateProfile(req);
  if (!profile) throw std::move(profile).status();
  std::cout << profile->DebugString() << "\n";

  return 0;
} catch (google::cloud::Status const& status) {
  std::cerr << "google::cloud::Status thrown: " << status << "\n";
  return 1;
}

Main classes

The main class in this library is profiler_v2::ProfilerServiceClient. All RPCs are exposed as member functions of this class. Other classes provide helpers, configuration parameters, and infrastructure to mock profiler_v2::ProfilerServiceClient when testing your application.

Retry, Backoff, and Idempotency Policies.

The library automatically retries requests that fail with transient errors, and uses exponential backoff to backoff between retries. Application developers can override the default policies.

More Information