@opencensus/exporter-stackdriver
    TypeScript icon, indicating that this package has built-in type declarations

    0.1.0 • Public • Published

    OpenCensus Stackdriver Exporter for Node.js

    Gitter chat

    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.

    The library is in alpha stage and the API is 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
    const 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

    Install

    npm i @opencensus/exporter-stackdriver

    DownloadsWeekly Downloads

    11,478

    Version

    0.1.0

    License

    Apache-2.0

    Unpacked Size

    79.5 kB

    Total Files

    17

    Last publish

    Collaborators

    • kjin
    • ofrobots
    • google-admin
    • isaikevych
    • google-wombot
    • mayurkale22