Cloud Profiler API: Node.js Client

Cloud Profiler API client for Node.js

A comprehensive list of changes in each version may be found in the CHANGELOG.

Read more about the client libraries for Cloud APIs, including the older Google APIs Client Libraries, in Client Libraries Explained.

Table of contents:

Quickstart
Samples
Versioning
Contributing
License

Quickstart

Before you begin

Select or create a Cloud Platform project.
Enable billing for your project.
Enable the Cloud Profiler API API.
Set up authentication with a service account so you can access the API from your local workstation.

Installing the client library

npm install @google-cloud/cloudprofiler

Using the client library

/**
 * This snippet has been automatically generated and should be regarded as a code template only.
 * It will require modifications to work.
 * It may require correct/in-range values for request initialization.
 * TODO(developer): Uncomment these variables before running the sample.
 */
/**
 *  Parent project to create the profile in.
 */
// const parent = 'abc123'
/**
 *  Deployment details.
 */
// const deployment = {}
/**
 *  One or more profile types that the agent is capable of providing.
 */
// const profileType = [1,2,3,4]

// Imports the Cloudprofiler library
const {ProfilerServiceClient} = require('@google-cloud/cloudprofiler').v2;

// Instantiates a client
const cloudprofilerClient = new ProfilerServiceClient();

async function callCreateProfile() {
  // Construct request
  const request = {
    project,
    deployment: {projectId, target},
    profileType: [profileType],
  };

  // Run request
  const response = await cloudprofilerClient.createProfile(request);
  console.log(response);
}

callCreateProfile();

Samples

Samples are in the samples/ directory. Each sample's README.md has instructions for running its sample.

Sample	Source Code	Try it
Export_service.list_profiles	source code
Profiler_service.create_offline_profile	source code
Profiler_service.create_profile	source code
Profiler_service.update_profile	source code
Quickstart	source code

The Cloud Profiler API Node.js Client API Reference documentation also contains samples.

Supported Node.js Versions

Our client libraries follow the Node.js release schedule. Libraries are compatible with all current active and maintenance versions of Node.js. If you are using an end-of-life version of Node.js, we recommend that you update as soon as possible to an actively supported LTS version.

Google's client libraries support legacy versions of Node.js runtimes on a best-efforts basis with the following warnings:

Legacy versions are not tested in continuous integration.
Some security patches and features cannot be backported.
Dependencies cannot be kept up-to-date.

Client libraries targeting some end-of-life versions of Node.js are available, and can be installed through npm dist-tags. The dist-tags follow the naming convention legacy-(version). For example, npm install @google-cloud/cloudprofiler@legacy-8 installs client libraries for versions compatible with Node.js 8.

Versioning

This library follows Semantic Versioning.

This library is considered to be in preview. This means it is still a work-in-progress and under active development. Any release is subject to backwards-incompatible changes at any time.

More Information: Google Cloud Platform Launch Stages

Contributing

Contributions welcome! See the Contributing Guide.

Please note that this README.md, the samples/README.md, and a variety of configuration files in this repository (including .nycrc and tsconfig.json) are generated from a central template. To edit one of these files, make an edit to its templates in directory.

License

Apache Version 2.0

See LICENSE