Socket
Socket
Sign inDemoInstall

@opencensus/nodejs

Package Overview
Dependencies
3
Maintainers
6
Versions
23
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @opencensus/nodejs

OpenCensus is a toolkit for collecting application performance and behavior data.


Version published
Weekly downloads
4.5K
decreased by-9.02%
Maintainers
6
Install size
56.2 MB
Created
Weekly downloads
 

Changelog

Source

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)

Readme

Source

OpenCensus for Node.js

Gitter chat

OpenCensus Node.js is an implementation of OpenCensus, a toolkit for collecting application performance and behavior monitoring data.

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

Please join gitter for help or feedback on this project.

Installation

Install OpenCensus with:

npm install @opencensus/nodejs

Traces

Instrumenting an Application

OpenCensus for Node.js has automatic instrumentation out of the box for those modules:

This means that spans are automatically created for operations of those packages. To use it, simply start the tracing instance.

const tracing = require('@opencensus/nodejs');
tracing.start();

Similarly for Typescript:

import * as tracing from '@opencensus/nodejs';
tracing.start();

Manually Instrument an Application

In addition to automatic tracing, it is possible to manually create your own root and child spans.

const rootSpanOptions = { name: 'your root span' };
tracing.tracer.startRootSpan(rootSpanOptions, (rootSpan) => {

    // You can create as many child spans as needed
    childSpan = tracing.tracer.startChildSpan({
        name: 'name of your child span'
    });
    // Do some operation...
    // Finish the child span at the end of it's operation
    childSpan.end();

    // Finish the root span at the end of the operation
    rootSpan.end();
});

For manual only instrumentation see the @opencensus/nodejs-base package.

Tracing Options

Tracing has many options available to choose from. At tracing.start(), you can set the following:

OptionsTypeDescription
defaultAttributesAttributesDefault attributes added to every span created by the tracer
bufferSizenumberThe number of traces to be collected before exporting to a backend
bufferTimeoutnumberMaximum time to wait before exporting to a backend
loggerLoggerA logger object
logLevelnumberLevel of logger - 0: disable, 1: error, 2: warn, 3: info, 4: debug
samplingRatenumberDetermines the span's sampling rate. Ranges from 0.0 to 1.0
propagationPropagationA propagation instance to use
maximumLabelValueSizenumberThe maximum number of characters reported on a label value
pluginsPluginNamesA list of trace instrumentations plugins to load
exporterExporterAn exporter object

Plugins

OpenCensus can collect tracing data automatically using plugins. Users can also create and use their own plugins. Currently, OpenCensus supports automatic tracing for:

Propagation

OpenCensus collects distributed tracing. It is able to do so by propagating span data through services. Currently, OpenCensus supports:

Exporters

OpenCensus can export trace data to various backends. Currently, OpenCensus supports:

If no exporter is registered in the tracing instance, as default, a console log exporter is used.

Keywords

FAQs

Last updated on 27 Jul 2021

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc