An idiomatic C++ client library for theCloud 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. Thetypes of profiling availableare listed in the service documentation.
While this library isGA, please note Google Cloud C++ client libraries donotfollowSemantic Versioning.
Quickstart
The following shows the code that you'll run in thegoogle/cloud/profiler/quickstart/directory, which should give you a taste of the Cloud Profiler API C++ client library API.
This library offers multiple*Clientclasses, which are listed below. Each one of these classes exposes all the RPCs for a service as member functions of the class. This library groups multiple services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.
The library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the*Clientclasses when testing your application.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[[["\u003cp\u003eThis webpage details the C++ client library for the Cloud Profiler API, which manages continuous CPU and heap profiling to enhance performance and reduce expenses.\u003c/p\u003e\n"],["\u003cp\u003eThe latest release candidate is version 2.37.0-rc, while version 2.30.0 is detailed within this webpage, and multiple other version releases from 2.36.0 all the way to 2.11.0 are also listed and navigable.\u003c/p\u003e\n"],["\u003cp\u003eAlthough the library is in General Availability (GA), Cloud Profiler currently does not offer profiling specifically for C++ applications, though the library is usable for interacting with Cloud Profiler.\u003c/p\u003e\n"],["\u003cp\u003eThe library provides \u003ccode\u003e*Client\u003c/code\u003e classes, including \u003ccode\u003eprofiler_v2::ExportServiceClient\u003c/code\u003e and \u003ccode\u003eprofiler_v2::ProfilerServiceClient\u003c/code\u003e, that expose RPCs for services, along with helper and configuration classes.\u003c/p\u003e\n"],["\u003cp\u003eThe quickstart section provides an example of code to demonstrate the Cloud Profiler API C++ client library, creating a profile in the target project and demonstrating the usage of creating a CPU profile.\u003c/p\u003e\n"]]],[],null,["Version 2.30.0keyboard_arrow_down\n\n- [2.42.0-rc (latest)](/cpp/docs/reference/profiler/latest)\n- [2.41.0](/cpp/docs/reference/profiler/2.41.0)\n- [2.40.0](/cpp/docs/reference/profiler/2.40.0)\n- [2.39.0](/cpp/docs/reference/profiler/2.39.0)\n- [2.38.0](/cpp/docs/reference/profiler/2.38.0)\n- [2.37.0](/cpp/docs/reference/profiler/2.37.0)\n- [2.36.0](/cpp/docs/reference/profiler/2.36.0)\n- [2.35.0](/cpp/docs/reference/profiler/2.35.0)\n- [2.34.0](/cpp/docs/reference/profiler/2.34.0)\n- [2.33.0](/cpp/docs/reference/profiler/2.33.0)\n- [2.32.0](/cpp/docs/reference/profiler/2.32.0)\n- [2.31.0](/cpp/docs/reference/profiler/2.31.0)\n- [2.30.0](/cpp/docs/reference/profiler/2.30.0)\n- [2.29.0](/cpp/docs/reference/profiler/2.29.0)\n- [2.28.0](/cpp/docs/reference/profiler/2.28.0)\n- [2.27.0](/cpp/docs/reference/profiler/2.27.0)\n- [2.26.0](/cpp/docs/reference/profiler/2.26.0)\n- [2.25.1](/cpp/docs/reference/profiler/2.25.1)\n- [2.24.0](/cpp/docs/reference/profiler/2.24.0)\n- [2.23.0](/cpp/docs/reference/profiler/2.23.0)\n- [2.22.1](/cpp/docs/reference/profiler/2.22.1)\n- [2.21.0](/cpp/docs/reference/profiler/2.21.0)\n- [2.20.0](/cpp/docs/reference/profiler/2.20.0)\n- [2.19.0](/cpp/docs/reference/profiler/2.19.0)\n- [2.18.0](/cpp/docs/reference/profiler/2.18.0)\n- [2.17.0](/cpp/docs/reference/profiler/2.17.0)\n- [2.16.0](/cpp/docs/reference/profiler/2.16.0)\n- [2.15.1](/cpp/docs/reference/profiler/2.15.1)\n- [2.14.0](/cpp/docs/reference/profiler/2.14.0)\n- [2.13.0](/cpp/docs/reference/profiler/2.13.0)\n- [2.12.0](/cpp/docs/reference/profiler/2.12.0)\n- [2.11.0](/cpp/docs/reference/profiler/2.11.0) \n\nCloud Profiler API C++ Client Library\n=====================================\n\nAn idiomatic C++ client library for the [Cloud Profiler API](https://cloud.google.com/profiler), a service that manages continuous CPU and heap profiling to improve performance and reduce costs.\n\nNote 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](https://cloud.google.com/profiler/docs/concepts-profiling#types_of_profiling_available) are listed in the service documentation.\n\nWhile this library is **GA** , please note Google Cloud C++ client libraries do **not** follow [Semantic Versioning](https://semver.org/).\n\n### Quickstart\n\nThe 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. \n\n #include \"google/cloud/profiler/v2/profiler_client.h\"\n #include \"google/cloud/project.h\"\n #include \u003ciostream\u003e\n\n int main(int argc, char* argv[]) try {\n if (argc != 2) {\n std::cerr \u003c\u003c \"Usage: \" \u003c\u003c argv[0] \u003c\u003c \" project-id\\n\";\n return 1;\n }\n\n namespace profiler = ::google::cloud::profiler_v2;\n auto client = profiler::ProfilerServiceClient(\n profiler::MakeProfilerServiceConnection());\n\n google::devtools::cloudprofiler::v2::CreateProfileRequest req;\n req.set_parent(google::cloud::Project(argv[1]).FullName());\n req.add_profile_type(google::devtools::cloudprofiler::v2::CPU);\n auto& deployment = *req.mutable_deployment();\n deployment.set_project_id(argv[1]);\n deployment.set_target(\"quickstart\");\n\n auto profile = client.CreateProfile(req);\n if (!profile) throw std::move(profile).status();\n std::cout \u003c\u003c profile-\u003eDebugString() \u003c\u003c \"\\n\";\n\n return 0;\n } catch (google::cloud::Status const& status) {\n std::cerr \u003c\u003c \"google::cloud::Status thrown: \" \u003c\u003c status \u003c\u003c \"\\n\";\n return 1;\n }\n\n### Main classes\n\nThis library offers multiple `*Client` classes, which are listed below. Each one of these classes exposes all the RPCs for a service as member functions of the class. This library groups multiple services because they are part of the same product or are often used together. A typical example may be the administrative and data plane operations for a single product.\n\nThe library also has other classes that provide helpers, configuration parameters, and infrastructure to mock the `*Client` classes when testing your application.\n\n- [`profiler_v2::ExportServiceClient`](/cpp/docs/reference/profiler/2.30.0/classgoogle_1_1cloud_1_1profiler__v2_1_1ExportServiceClient)\n- [`profiler_v2::ProfilerServiceClient`](/cpp/docs/reference/profiler/2.30.0/classgoogle_1_1cloud_1_1profiler__v2_1_1ProfilerServiceClient)\n\n### More Information\n\n- [Error Handling](https://cloud.google.com/cpp/docs/reference/common/latest/common-error-handling.html) - describes how the library reports errors.\n- [How to Override the Default Endpoint](/cpp/docs/reference/profiler/2.30.0/profiler-override-endpoint) - describes how to override the default endpoint.\n- [How to Override the Authentication Credentials](/cpp/docs/reference/profiler/2.30.0/profiler-override-authentication) - describes how to change the authentication credentials used by the library.\n- [Override Retry, Backoff, and Idempotency Policies](/cpp/docs/reference/profiler/2.30.0/profiler-override-retry) - describes how to change the default retry policies.\n- [Environment Variables](/cpp/docs/reference/profiler/2.30.0/profiler-env) - describes environment variables that can configure the behavior of the library."]]