node-service-metrics-logger v0.0.2

❯ Why

You want to log service metrics from your application and push it to a metrics provided? - Yes? - Here you are 🙌 !!
Currently there's only support for Datadog as metrics provider.

❯ Table of Contents

• Supported Services
• Quick Start
• API
• Cloud Connectors
• Transports
• Development
• Project Structure

❯ Supported Services

❯ Quick Start

Installation

Install library by using npm

npm install node-service-metrics-logger

or by using yarn

yarn add node-service-metrics-logger

How to use

Step 1: Import NodeServiceMetricsLogger

Using CommonJS module loader:

const NodeServiceMetricsLogger = require('node-service-metrics-logger);

Using ES6 module loader:

import { NodeServiceMetricsLogger } from 'node-service-metrics-logger;

Step 2: Create new instance of CfServiceMetricsLogger

Create new instance of NodeServiceMetricsLogger and provide options:

const serviceCredentials = [
  {
    serviceType: 'mongodb',
    host: 'your-mongodb-host',
    username: 'user',
    password: 'this-is-secret',
    port: 27017
    database: 'your-database-name',
  },
  {
    serviceType: 'redis',
    host: 'your-redis-host',
    port: 6379,
    password: 'this-is-secret',
  }
];

const nodeServiceMetricsLogger = new NodeServiceMetricsLogger({serviceCredentials});

Step 3: Subscribe to receive service metrics and general logs

Subscribe metrics to receive service metrics data:

nodeServiceMetricsLogger.subscribe('metrics', data => {
  // do some fancy stuff with your metrics
});

Subscribe logs to receive general application logs:

nodeServiceMetricsLogger.subscribe('logs', {message, level} => {
  console[level](message));
});

Step 3: Start and stop service metrics logging

Start service metrics logging:

nodeServiceMetricsLogger.start();

Stop service metrics logging:

nodeServiceMetricsLogger.stop();

❯ API

Credentials Options

Methods

Subscription event id's

❯ Cloud Connectors

You can use a cloud connector to log metrics from your cloud instance services.

Cloud Foundry

Options

Methods

Example

// import using `CommonJS` module loader:
const { CloudFoundryConnector, NodeServiceMetricsLogger } = require('node-service-metrics-logger');

// or import using `ES6` module loader:
import { CloudFoundryConnector, NodeServiceMetricsLogger } from 'node-service-metrics-logger';

const options = {
  vcapFile: 'your-vcap-file-path/vcap.json' 
};

const cloudFoundryConnector = new CloudFoundryConnector(options);
const serviceCredentials = cloudFoundryConnector.getCredentials();
const nodeServiceMetricsLogger = new NodeServiceMetricsLogger({serviceCredentials});

nodeServiceMetricsLogger.subscribe('metrics', data => {
  // do some fancy stuff with your metrics
});

nodeServiceMetricsLogger.start();

setTimeout(() => {
  nodeServiceMetricsLogger.stop();
}, 30000);

❯ Transports

With transports you can log metrics to metrics services like Datadog. Datadog is currently the one and only implemented transport.

Datadog

Example

// import using `CommonJS` module loader:
const { NodeServiceMetricsLogger, DatadogTransport } = require('node-service-metrics-logger');

// or import using `ES6` module loader:
import { NodeServiceMetricsLogger, DatadogTransport } from 'node-service-metrics-logger';

const datadogTransport = new DatadogTransport({
  apiKey: 'datadog-api-key',
  appKey: 'datadog-app-key',
  host: 'app.datadoghq.com',
  tags: ['env:development']
});

const serviceCredentials = [
  {
    serviceType: 'mongodb',
    host: 'your-mongodb-host',
    username: 'user',
    password: 'this-is-secret',
    port: 27017,
    database: 'your-database-name',
  }
];

const nodeServiceMetricsLogger = new NodeServiceMetricsLogger({
  serviceCredentials,
  transports: [datadogTransport],
});

nodeServiceMetricsLogger.start();

❯ Development

Getting Started

Step 1: Set up the Development Environment

You need to set up your development environment before you can do anything.

Install Node.js and NPM

• on OSX use homebrew brew install node
• on Windows use chocolatey choco install nodejs

Install yarn globally

yarn install yarn -g

Step 2: Install dependencies

Install all dependencies with yarn.

yarn install

Scripts and Tasks

Install

• Install all dependencies with yarn install

Linting

• Run code quality analysis using yarn run lint. This runs tslint.

Tests

• Run unit test using yarn run test.

Building the project

• Run yarn run build to generate commonJS and ES6 modules as well as declaration from the TypeScript source.
• Builded sources are located in dist folder.

Debugger

VS Code

Just set a breakpoint in source or unit test and hit F5 in your Visual Studio Code to execute and debug all unit tests.

❯ Project Structure