@opencensus/exporter-ocagent

OpenCensus Agent Exporter for Node.js

OpenCensus Agent Exporter allows the user to send collected traces with OpenCensus Node.js to the OpenCensus Agent or Collector.

The library is in alpha stage and the API is subject to change.

Installation

Install OpenCensus Agent Exporter with:

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

Usage

Instance the exporter on your application. For javascript:

const tracing = require('@opencensus/nodejs');
const ocagent = require('@opencensus/exporter-ocagent');

const exporter = new ocagent.OCAgentExporter({
  // ... configuration options ...
});

tracing.registerExporter(exporter).start();

Similarly for Typescript:

import * as tracing from '@opencensus/nodejs';
import { OCAgentExporter } from '@opencensus/exporter-ocagent';

const exporter = new OCAgentExporter({
  // ... configuration options ...
});

Now, register the exporter and start tracing.

tracing.start({exporter: exporter});

or

tracing.registerExporter(exporter).start();

Configuration Options

The following options are available through the construtor options.

Option	Type	Description
serviceName	string	Name of the service. Defaults to Anonymous Service.
host	string	Host or ip of the agent. Defaults to localhost.
port	number	Port of the agent. Defaults to 55678.
credentials	grpc.ChannelCredentials	Credentials to use for grpc connection to agent. Defaults to grpc.credentials.createInsecure().
attributes	{[key: string]: string}	Map of key-value pairs to associate with the Node.
bufferSize	number	Maximum size of the span buffer.
bufferTimeout	number	Max time (in milliseconds) for the buffer can wait before exporting spans.
logger	Logger	Logger to use for output.

Useful links

• 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.1.0 - 2021-07-27

• chore(stackdriver): upgrade google-auth-library, drop node8 (#887)
• chore: upgrade gRPC, ts to newest compatible version (#907) BREAKING CHANGE: upgrade to TypeScript 3.x
• chore(deps): pin googleapis, lock file maintenance (#928)