Giter VIP home page Giter VIP logo

riemann-nodejs-client's Introduction

Riemann Node.js Client

Riemann NodeJS Client testing

because you should be monitoring all of those non-blocking buffet plates.

Installation

npm install riemann

Getting Started

first things first, we'll want to establish a new client:

var client = require('riemann').createClient({
  host: 'some.riemann.server',
  port: 5555
});

client.on('connect', function() {
  console.log('connected!');
});

Promise-based workflow is supported, too. Just pass 'returnPromise' flag set to true. All the Client's methods will return promises in that case.

var client = await require('riemann').createClient({
  host: 'some.riemann.server',
  port: 5555,
  returnPromise: true
});

Just like Riemann ruby client, the client sends small events over UDP, by default. TCP is used for queries, and large events. There is no acknowledgement of UDP packets, but they are roughly an order of magnitude faster than TCP. We assume both TCP and UDP are listening to the same port.

sending events is easy (see list of valid event properties):

client.send(client.Event({
  service: 'buffet_plates',
  metric:  252.2,
  tags:    ['nonblocking']
}));

If you wanted to send that message over TCP and receive an acknowledgement, you can specify the transport, explicitly:

client.on('data', function(ack) {
  console.log('got it!');
});

client.send(client.Event({
  service: 'buffet_plates',
  metric:  252.2,
  tags:    ['nonblocking']
}), client.tcp);

// ... or via promises

var data = await client.send(client.Event({
  service: 'buffet_plates',
  metric:  252.2,
  tags:    ['nonblocking']
}), client.tcp);

You can also send events with custom attributes:

client.send(client.Event({
  service: 'buffet_plates',
  metric: 150,
  attributes: [{key: "sessionID", value: "000-001-165"}],
  tags: ['nonblocking']
}), client.tcp);

When you're done monitoring, disconnect:

client.on('disconnect', function(){
  console.log('disconnected!');
});
client.disconnect();

// ... or just

await client.disconnect();

Contributing

Contributing is easy, just send me a pull request. Please take a look at the project issues, to see how you can help. Here are some helpful tips:

  • install the dependencies using npm install.
  • install Riemann using the quickstart instructions. A running Riemann server is required to run the tests.
  • please add tests. I'm using Mocha as a test runner, you can run the tests using npm run test
  • please check your syntax with the included jshint configuration using npm run lint. It shouldn't report any errors.

riemann-nodejs-client's People

Contributors

perezd avatar lassic avatar dmitrig01 avatar or-zarchi-forter avatar elly-mandliel-forter avatar lirown avatar wjlroe avatar snyk-bot avatar

Watchers

Oren Itamar avatar  avatar Tomer Eiges avatar Oren Ellenbogen avatar Itai Friendinger avatar James Cloos avatar  avatar Doron Yaacoby avatar Alon avatar Nadav Amir avatar ori weingart avatar Avishay Matayev avatar Ran avatar Erez Koren avatar Liron Goldenberg avatar Anya Tchernishov avatar Daniel Davidovich avatar  avatar Or Polaczek avatar Tal Bortman avatar Nir Aran avatar Assaf Milman avatar Daniel Eliad avatar Yacov Buchritz avatar Yam Raifen avatar Liat Rudner avatar Eliran Pe'er avatar Sagi Zur avatar Moran Faingold avatar cecico avatar Nathan Meisels avatar Tomer Tiplitsky avatar Daniel Grossman avatar  avatar

Forkers

isabella232

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.