# gcloud-monitor

> Custom Google Cloud monitoring v3 client

Latest version **1.3.0** (published 2016-12-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install gcloud-monitor
pnpm add gcloud-monitor
yarn add gcloud-monitor
bun add gcloud-monitor
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.3.0 |
| Published | 2016-12-17 |
| First published | 2016-12-09 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 (+2 in 2 direct dependencies) |
| Install scripts | no |
| GitHub stars | 6 |
| Author | Tejesh Mehta |
| Maintainers | tjmehta |
| Keywords | google, cloud, stackdriver, monitoring, custom, v3, monitor, client, api, gcloud, metrics, timeseries, gauge, cumulative, promise, promises |

## Links

- npm: https://www.npmjs.com/package/gcloud-monitor
- Repository: https://github.com/tjmehta/gcloud-monitor
- Homepage: https://github.com/tjmehta/gcloud-monitor#readme
- Issues: https://github.com/tjmehta/gcloud-monitor/issues
- npm.io page: https://npm.io/package/gcloud-monitor

## Dependencies (4)

- [101](https://npm.io/package/101.md) ^1.6.2
- [rxjs](https://npm.io/package/rxjs.md) ^5.0.0-rc.5
- [googleapis](https://npm.io/package/googleapis.md) ^14.2.0
- [timeout-then](https://npm.io/package/timeout-then.md) ^1.1.0

## Alternatives

- [launchdarkly-js-client-sdk](https://npm.io/package/launchdarkly-js-client-sdk.md) — 2.5M weekly downloads
- [@elastic/elasticsearch](https://npm.io/package/@elastic/elasticsearch.md) — 2.1M weekly downloads
- [@c8y/client](https://npm.io/package/@c8y/client.md) — 15.3K weekly downloads
- [@signaldb/maverickjs](https://npm.io/package/@signaldb/maverickjs.md) — 1.7K weekly downloads
- [@bbc/http-transport-cache](https://npm.io/package/@bbc/http-transport-cache.md) — 1.2K weekly downloads

## Recent versions

- 1.3.0 (latest) — 2016-12-17
- 1.2.1 — 2016-12-15
- 1.2.0 — 2016-12-15
- 1.1.2 — 2016-12-14
- 1.1.1 — 2016-12-13
- 1.1.0 — 2016-12-13
- 1.0.1 — 2016-12-09
- 1.0.0 — 2016-12-09

## README

# gcloud-monitor [![Build Status](https://travis-ci.org/tjmehta/gcloud-monitor.svg?branch=master)](https://travis-ci.org/tjmehta/gcloud-monitor) [![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat)](http://standardjs.com/)
A node.js module for Custom monitoring using Google Cloud Monitoring v3 API

## Installation
```bash
npm i --save gcloud-monitor
```

## Usage

### Gauge

#### Create a Gauge Metric
```js
const monitor = require('gcloud-monitor')({
  project: '<google-cloud-project-name>',
  resource: {
    // optional, defaults to {type: 'global'}
    // more info: https://cloud.google.com/monitoring/api/ref_v3/rest/v3/MonitoredResource
  },
  auth: {
    // optional, if using on GCE
    // more info: https://github.com/google/google-api-nodejs-client#authorizing-and-authenticating
  },
  // optional: default report throttle time
  timeout: 1000
})

/**
 * create a gauge
 * more info: https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricDescriptor
 * @param  {String} metricType
 * @param  {Object} [opts] metric params
 * @param  {Object} [opts.throttle] // report throttle time
 * @param  {Object} [opts.description]
 * @param  {Object} [opts.displayName]
 * @param  {Object} [opts.labels] label descriptors
 * @param  {Object} [opts.metricDomain] default: 'custom.googleapis.com'
 * @param  {Object} [opts.unit]
 * @param  {Object} [opts.valueType] default: 'INT64'
 * @return {Promise<Gauge,Error>} resolves gauge instance
 */
monitor.createGauge('connections', {
  displayName: 'Connections',
  description: 'Active socket connection count',
  labels: [{
    key: 'foo',
    description: 'foo label description',
    valueType: 'INT64'
  }],
  unit: 'connections',
  valueType: 'INT64'
}).then((gauge) => {
  // use gauge...
})
```

#### Report Gauge Metric Data
```js
/**
 * report a metric value
 * @param  {*} value
 * @param  {Date} [time]
 * @param  {Object} [labels]
 * @return {Promise}
 */
gauge.report(1, new Date(), {
  foo: 1
}).then((data) => {
  console.log('Response data', data)
})
```

#### Delete a Gauge Metric
```js
/**
 * delete the cumulative metric
 * @return {Promise}
 */
gauge.delete().then(function (data) {
  console.log('Response data', data)
})
```

### Cumulative

#### Create a Cumulative Metric
```js
const monitor = require('gcloud-monitor')({
  project: '<google-cloud-project-name>',
  auth: {/*auth-json*/} // optional, if using on GCE
})

/**
 * create a cumulative metric
 * more info: https://cloud.google.com/monitoring/api/ref_v3/rest/v3/projects.metricDescriptors#MetricDescriptor
 * @param  {String} metricType
 * @param  {Object} [opts] metric params
 * @param  {Object} [opts.description]
 * @param  {Object} [opts.displayName]
 * @param  {Object} [opts.labels] label descriptors
 * @param  {Object} [opts.metricDomain] default: 'custom.googleapis.com'
 * @param  {Object} [opts.unit]
 * @param  {Object} [opts.valueType] default: INT64
 * @return {Promise<Model,Error>} resolves Cumulative instance
 */
monitor.createCumulative('requestsPerSecond', {
  displayName: 'Requests per Second',
  description: 'Active socket connection count',
  labels: [{
    key: 'foo',
    description: 'foo label description',
    valueType: 'INT64'
  }],
  unit: 'req/s',
  valueType: 'INT64'
}).then((cumulative) => {
  // use cumulative...
})
```

#### Report Cumulative Metric Data
```js
/**
 * report a metric value
 * @param  {*} value
 * @param  {Object|Date} [interval|endTime]
 * @param  {Object} [interval.startTime] default: last `interval.startTime` or `createCumulative` time
 * @param  {Object} [interval.endTime]
 * @param  {Object} [labels]
 * @return {Promise}
 */
cumulative.report(1, {
  startTime: startTime,
  endTime: new Date()
}, {
  foo: 1
}).then((data) => {
  console.log('Response data', data)
})
```

#### Delete a Cumulative Metric
```js
/**
 * delete the cumulative metric
 * @return {Promise}
 */
cumulative.delete().then(function (data) {
  console.log('Response data', data)
})
```

#### Note about throttle
Throttle can be set globally as `gcloud-monitor` `opt` or on each individual "metric" as a factory `opt`. This option throttles metric reports to the interval specified in ms.

Cumulative time series metrics batching can be grouped by passing `opt.groupBy` function. For example, if you want to batch cumulative metric data grouped by label `name`: `groupBy: (timeSeriesItem) => (timeSeriesItem.metric.labels && timeSeriesItem.metric.labels.name)`

## License
MIT

---
_Source: https://npm.io/package/gcloud-monitor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._