|
1 | | -# @google-cloud/monitoring ([Alpha][versioning]) |
2 | | -> Google Stackdriver Monitoring Client Library for Node.js |
| 1 | +# Node.js Clients for Stackdriver Monitoring API ([Beta](https://github.com/GoogleCloudPlatform/google-cloud-node#versioning)) |
3 | 2 |
|
4 | | -*Looking for more Google APIs than just Monitoring? You might want to check out [`google-cloud`][google-cloud].* |
| 3 | +[Stackdriver Monitoring API][Product Documentation]: Manages your Stackdriver Monitoring data and configurations. Most projects must be associated with a Stackdriver account, with a few exceptions as noted on the individual method pages. |
5 | 4 |
|
6 | | -- [Official Documentation][cloud-monitoring-docs] |
| 5 | +- [Client Library Documentation][] |
| 6 | +- [Product Documentation][] |
7 | 7 |
|
8 | | -## This is an auto-generated API |
| 8 | +## Quick Start |
| 9 | +In order to use this library, you first need to go through the following steps: |
9 | 10 |
|
10 | | -It does not follow the conventions you're familiar with from other parts of our library. A handwritten layer is not yet available. |
| 11 | +1. [Select or create a Cloud Platform project.](https://console.cloud.google.com/project) |
| 12 | +2. [Enable the Stackdriver Monitoring API.](https://console.cloud.google.com/apis/api/monitoring) |
| 13 | +3. [Setup Authentication.](https://googlecloudplatform.github.io/google-cloud-node/#/docs/google-cloud/master/guides/authentication) |
11 | 14 |
|
12 | | -The example below shows you how to instantiate the generated client. For further documentation, please browse the [Monitoring .proto files][cloud-monitoring-protos] on GitHub. |
13 | | - |
14 | | - |
15 | | -```sh |
16 | | -$ npm install --save @google-cloud/monitoring |
17 | | -``` |
18 | | -```js |
19 | | -var monitoring = require('@google-cloud/monitoring').v3({ |
20 | | - projectId: 'grape-spaceship-123', |
21 | | - keyFilename: '/path/to/keyfile.json' |
22 | | -}); |
| 15 | +### Installation |
23 | 16 | ``` |
24 | | - |
25 | | - |
26 | | -## Authentication |
27 | | - |
28 | | -It's incredibly easy to get authenticated and start using Google's APIs. You can set your credentials on a global basis as well as on a per-API basis. See each individual API section below to see how you can auth on a per-API-basis. This is useful if you want to use different accounts for different Cloud services. |
29 | | - |
30 | | -### On Google Cloud Platform |
31 | | - |
32 | | -If you are running this client on Google Cloud Platform, we handle authentication for you with no configuration. You just need to make sure that when you [set up the GCE instance][gce-how-to], you add the correct scopes for the APIs you want to access. |
33 | | - |
34 | | -``` js |
35 | | -// Authenticating on a global basis. |
36 | | -var monitoring = require('@google-cloud/monitoring').v3(); |
37 | | -// ...you're good to go! |
| 17 | +$ npm install --save @google-cloud/monitoring |
38 | 18 | ``` |
39 | 19 |
|
40 | | -### Elsewhere |
41 | | - |
42 | | -If you are not running this client on Google Cloud Platform, you need a Google Developers service account. To create a service account: |
43 | | - |
44 | | -1. Visit the [Google Developers Console][dev-console]. |
45 | | -2. Create a new project or click on an existing project. |
46 | | -3. Navigate to **APIs & auth** > **Credentials** and then: |
47 | | - * If you want to use a new service account key, click on **Create credentials** and select **Service account key**. After the account key is created, you will be prompted to download the JSON key file that the library uses to authenticate your requests. |
48 | | - * If you want to generate a new service account key for an existing service account, click on **Generate new JSON key** and download the JSON key file. |
49 | | - |
50 | | -``` js |
51 | | -var monitoring = require('@google-cloud/monitoring').v3({ |
52 | | - // The path to your key file: |
53 | | - keyFilename: '/path/to/keyfile.json' |
54 | | - |
55 | | - // Or the contents of the key file: |
56 | | - credentials: require('./path/to/keyfile.json') |
57 | | -}); |
58 | | - |
59 | | -// ...you're good to go! |
| 20 | +### Preview |
| 21 | +#### MetricServiceClient |
| 22 | +```js |
| 23 | + var monitoring = require('@google-cloud/monitoring'); |
| 24 | + |
| 25 | + var client = monitoring.metric({ |
| 26 | + // optional auth parameters. |
| 27 | + }); |
| 28 | + |
| 29 | + // Iterate over all elements. |
| 30 | + var formattedName = client.projectPath(projectId); |
| 31 | + |
| 32 | + client.listMonitoredResourceDescriptors({name: formattedName}).then(function(responses) { |
| 33 | + var resources = responses[0]; |
| 34 | + for (var i = 0; i < resources.length; ++i) { |
| 35 | + // doThingsWith(resources[i]) |
| 36 | + } |
| 37 | + }) |
| 38 | + .catch(function(err) { |
| 39 | + console.error(err); |
| 40 | + }); |
| 41 | + |
| 42 | + // Or obtain the paged response. |
| 43 | + var formattedName = client.projectPath(projectId); |
| 44 | + |
| 45 | + |
| 46 | + var options = {autoPaginate: false}; |
| 47 | + function callback(responses) { |
| 48 | + // The actual resources in a response. |
| 49 | + var resources = responses[0]; |
| 50 | + // The next request if the response shows there's more responses. |
| 51 | + var nextRequest = responses[1]; |
| 52 | + // The actual response object, if necessary. |
| 53 | + // var rawResponse = responses[2]; |
| 54 | + for (var i = 0; i < resources.length; ++i) { |
| 55 | + // doThingsWith(resources[i]); |
| 56 | + } |
| 57 | + if (nextRequest) { |
| 58 | + // Fetch the next page. |
| 59 | + return client.listMonitoredResourceDescriptors(nextRequest, options).then(callback); |
| 60 | + } |
| 61 | + } |
| 62 | + client.listMonitoredResourceDescriptors({name: formattedName}, options) |
| 63 | + .then(callback) |
| 64 | + .catch(function(err) { |
| 65 | + console.error(err); |
| 66 | + }); |
60 | 67 | ``` |
61 | 68 |
|
| 69 | +### Next Steps |
| 70 | +- Read the [Client Library Documentation][] for Stackdriver Monitoring API to see other available methods on the client. |
| 71 | +- Read the [Stackdriver Monitoring API Product documentation][Product Documentation] to learn more about the product and see How-to Guides. |
| 72 | +- View this [repository's main README](https://github.com/GoogleCloudPlatform/google-cloud-node/blob/master/README.md) to see the full list of Cloud APIs that we cover. |
62 | 73 |
|
63 | | -[versioning]: https://github.com/GoogleCloudPlatform/google-cloud-node#versioning |
64 | | -[google-cloud]: https://github.com/GoogleCloudPlatform/google-cloud-node/ |
65 | | -[gce-how-to]: https://cloud.google.com/compute/docs/authentication#using |
66 | | -[dev-console]: https://console.developers.google.com/project |
67 | | -[cloud-monitoring-docs]: https://cloud.google.com/monitoring/docs |
68 | | -[cloud-monitoring-protos]: https://github.com/googleapis/googleapis/tree/master/google/monitoring/v3 |
| 74 | +[Client Library Documentation]: https://googlecloudplatform.github.io/google-cloud-node/#/docs/monitoring |
| 75 | +[Product Documentation]: https://cloud.google.com/monitoring |
0 commit comments