Git Product home page Git Product logo

cloud-analytics-ts's Introduction

Cloud Analytics: Typescript

Cloud Analytics is a library used for logging product usage metrics for Cloud products. Data is stored in the Concord Data Warehouse in a privacy compliant manner.

How to use the library

Logging a single event can be done by creating an instance of CloudAnalytics and passing an event to logEvent.

import {CloudAnalytics} from './cloud_analytics';

const cloudAnalytics = new CloudAnalytics(
        'TEST',
        'testApiKey');

const concordEvent = {
    type: 'eventType',
    name: 'eventName',
    projectNumber: '1234567890',
    latency: 123,
    metadata: [
      {key: 'test1', value: 'data1'},
      {key: 'test2', value: 'data2'},
    ],
    userSessionId: '12345',
  };

cloudAnalytics.logEvent(concordEvent);

Batching Events

Batching can be configured by calling enableBatchMode with a desired flush interval. Events will be queued until the specified interval is reached, or until various browser environment events occur. These include document page hide, window beforeUnload & unload. For Node.JS these include the beforeExit SIGHUP events.

In the below snippet these two calls to logEvent are batched and sent along in the same HTTP request.

import {CloudAnalytics} from './cloud_analytics';

const cloudAnalytics = new CloudAnalytics(
        'TEST',
        'testApiKey');

cloudAnalytics.enableBatchMode(1000);

const concordEventOne = {
    type: 'eventType',
    name: 'eventName',
    projectNumber: '1234567890',
    latency: 123,
    metadata: [
      {key: 'test1', value: 'data1'},
      {key: 'test2', value: 'data2'},
    ],
    userSessionId: '12345',
  };

cloudAnalytics.logEvent(concordEventOne);

const concordEventOne = {
    type: 'eventType',
    name: 'eventName',
    projectNumber: '1234567890',
    latency: 456,
    metadata: [
      {key: 'test1', value: 'data1'},
      {key: 'test2', value: 'data2'},
    ],
    userSessionId: '12345',
  };


cloudAnalytics.logEvent(concordEventOne);

cloud-analytics-ts's People

Stargazers

 avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.