Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@opencensus/exporter-zpages

Package Overview
Dependencies
Maintainers
6
Versions
23
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@opencensus/exporter-zpages

A collection of HTML pages to display stats and trace data and allow library configuration control

  • 0.1.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
6
Created
Source

OpenCensus Zpages Exporter for Node.js

Gitter chat

OpenCensus Zpages Exporter implements a collection of HTML pages that display stats and trace data sent from OpenCensus Node.js.

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

Installation

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

Usage

Zpages always runs on localhost, but you can change the port in the options. If the option startServer is set to true, Zpages server will start when a new Zpages instance is created. It's also possible to predefined some span names. These empty spans will be listed on Zpages.

To use Zpages, instance the exporter on your application and pass the options. For javascript:

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

// Add your zipkin url and application name to the Zipkin options
const options = {
  port: 8080,   // default
  startServer: true,  // default
  spanNames: ['predefined/span1', 'predefined/span2']
}

const exporter = new zpages.ZpagesExporter(options);

Similarly for Typescript:

import * as tracing from '@opencensus/nodejs';
import {ZpagesExporter, ZpagesExporterOptions} from '@opencensus/zpages-exporter';

// Add your zipkin url and application name to the Zipkin options
const options: ZpagesExporterOptions = {
  port: 8080,   // default
  startServer: true,  // default
  spanNames: ['predefined/span1', 'predefined/span2']
};

const exporter = new ZpagesExporter(options);

Now, register the exporter and start tracing.

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

or

tracing.registerExporter(exporter).start();

Starting the Zpages server

If options.startServer is set to false, the server can be started by calling startServer method:

zpages.startServer();

The server will run at http:\\localhost:port.

Browsing the Zpages pages

There are four pages you can browse.

  • /tracez: Trace list.

  • /traceconfigz: Trace settings.

  • /rpcz: RPC stats (not yet implemented).

  • /stats: Stats page (not yet implemented).

Stoping the Zpages server

If it is necessary to stop the server programmatically, use the following command:

zpages.stopServer();

Keywords

FAQs

Package last updated on 27 Jul 2021

Did you know?

Socket

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
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc