@opencensus/exporter-stackdriver

OpenCensus Stackdriver Exporter for Node.js

OpenCensus Stackdriver Exporter allows the user to send collected traces with OpenCensus Node.js and stats with OpenCensus Core to Stackdriver Cloud Tracing and Stackdriver Monitoring.

This project is still at an early stage of development. It's subject to change.

OpenCensus Stackdriver Trace Exporter

Installation

Install OpenCensus Stackdriver Exporter with:

npm install @opencensus/nodejs
npm install @opencensus/exporter-stackdriver

Usage

To use Stackdriver as your exporter, make sure you have enabled Stackdriver Tracing on Google Cloud Platform. Enable your Application Default Credentials for authentication with:

export GOOGLE_APPLICATION_CREDENTIALS=path/to/your/credential.json

Create and register the exporter on your application and pass your Project ID.

For Javascript:

const tracing = require('@opencensus/nodejs');
const { StackdriverTraceExporter } = require('@opencensus/exporter-stackdriver');

// Add your project id to the Stackdriver options
var exporter = new StackdriverTraceExporter({projectId: "your-project-id"});

tracing.registerExporter(exporter).start();

Similarly for TypeScript:

import * as tracing from '@opencensus/nodejs';
import { StackdriverTraceExporter } from '@opencensus/exporter-stackdriver';

// Add your project id to the Stackdriver options
const exporter = new StackdriverTraceExporter({projectId: "your-project-id"});

Now, register the exporter and start tracing.

tracing.start({'exporter': exporter});

or

tracing.registerExporter(exporter).start();

Viewing your traces:

With the above you should now be able to navigate to the Stackdriver UI at: https://console.cloud.google.com/traces/traces

OpenCensus Stackdriver Stats(Metrics) Exporter

Installation

Install OpenCensus Stackdriver Exporter with:

npm install @opencensus/core
npm install @opencensus/exporter-stackdriver

Usage

To use Stackdriver as your exporter, make sure you have enabled Stackdriver Monitoring on Google Cloud Platform. Enable your Application Default Credentials for authentication with:

export GOOGLE_APPLICATION_CREDENTIALS=path/to/your/credential.json

Create and register the exporter on your application.

For Javascript:

const { globalStats } = require('@opencensus/core');
const { StackdriverStatsExporter } = require('@opencensus/exporter-stackdriver');

// Add your project id to the Stackdriver options
const exporter = new StackdriverStatsExporter({ projectId: "your-project-id" });

// Pass the created exporter to Stats
globalStats.registerExporter(exporter);

Similarly for TypeScript:

import { globalStats } from '@opencensus/core';
import { StackdriverStatsExporter } from '@opencensus/exporter-stackdriver';

// Add your project id to the Stackdriver options
const exporter = new StackdriverStatsExporter({ projectId: "your-project-id" });

// Pass the created exporter to Stats
globalStats.registerExporter(exporter);

Viewing your metrics:

With the above you should now be able to navigate to the Stackdriver UI at: https://console.cloud.google.com/monitoring

Useful links

• To know more about Stackdriver, visit: https://cloud.google.com/docs/authentication/getting-started
• For more information on OpenCensus, visit: https://opencensus.io/
• To checkout the OpenCensus for Node.js, visit: https://github.com/census-instrumentation/opencensus-node
• For help or feedback on this project, join us on gitter

Changelog

0.0.9 - 2019-02-12

• Add Metrics API.
• Add Resource API.
• Add Tags API.
• Add Gauges (DoubleGauge, LongGauge, DerivedDoubleGauge, DerivedLongGauge) APIs.
• Add support for supplying instrumentation configuration via tracing option. Option argument added to instrumentation interface.
• Add ignoreIncomingPaths and ignoreOutgoingUrls support to the http and https tracing instrumentations.
• Add opencensus-resource-util to auto detect AWS, GCE and Kubernetes(K8S) monitored resource, based on the environment where the application is running.
• Add optional uncompressedSize and compressedSize fields to MessageEvent interface.
• Add a setStatus method in the Span.
• OpenCensus Stackdriver Trace Exporter is updated to use Stackdriver Trace V2 APIs.

This release has multiple breaking changes. Please test your code accordingly after upgrading.

• Modify Logger interface: level made optional, silly removed.
• The new Stats() has been deprecated on Stats class. The global singleton globalStats object should be used instead. Also, registerView() is separated out from createView().
• Use TagKey, TagValue and TagMap to create the tag keys, tag values.
• The status field on Span is no longer a number, use CanonicalCode instead.
• Add enum type for MessageEvent, Link and SpanKind, instead of string.

Old code

const { Stats } = require("@opencensus/core");
const stats = new Stats();

// Counts/groups the lengths of lines read in.
const mLineLengths = stats.createMeasureInt64(
  "demo/line_lengths",
  MeasureUnit.BYTE,
  "The distribution of line lengths"
);

// Create tag keys
const tagKeys = ["method", "status"];

// Create and register the view
stats.createView(
  "demo/lines_in",
  mLineLengths,
  AggregationType.COUNT,
  tagKeys,
  "The number of lines from standard input"
);

// Records measurements
stats.record({
  measure: mLineLengths,
  tags,
  value: 2
});

New code

// Gets the global stats instance
const { globalStats } = require("@opencensus/core");

// Counts/groups the lengths of lines read in.
const mLineLengths = globalStats.createMeasureInt64(
  "demo/line_lengths",
  MeasureUnit.BYTE,
  "The distribution of line lengths"
);

// Creates the method and status key
const methodKey = {name: "method"};
const statusKey = {name: "status"};

// Creates the view
const view = globalStats.createView(
  "demo/lines_in",
  mLineLengths,
  AggregationType.COUNT,
  [methodKey, statusKey],
  "The number of lines from standard input"
);

// Registers the view
globalStats.registerView(view);

// Creates tags map -> key/value pair
const tagMap = new TagMap();
tagMap.set(methodKey, {value: 'REPL'});
tagMap.set(statusKey, {value: 'OK'});

// Creates measurements (measure + value)
const measurements = [{
  measure: mLineLengths,
  value: 2
}];

// Records measurement with tagMap
globalStats.record(measurements, tagMap);