Skip to content
A small client that posts and retrieves logs generated by your apps based on Node.js
JavaScript
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
example
lib
test
.gitignore
README.md
index.js
package.json

README.md

node-giraffi

A small client that posts and retrieves logs generated by your apps based on node.js

Requirements

Usage

Setup

First, set up an applog server (here we use giraffi-applog) on localhost. Running rake test is optional.

 git clone git://github.com/giraffi/giraffi-applog.git giraffi-applog
 cd giraffi-applog/
 gem install bundler
 bundle install --path vendor/bundle
 mongod --nojournal --dbpath ~/mongodb-xxx-xxx_xx-2.0.0/your-dbpath
 rake test
 bundle exec rackup -s thin -p 3000 config.ru

Then install node-giraffi using npm.

 npm install giraffi 

Start logging

Wanna post logs?

 // Load giraffi
 var giraffi = require('giraffi');

 // Configure your applog server
 var config = {
   host: "localhost:3000",
   ssl: false
 };

 // Create a client object and start posting logs 
 var client = giraffi.createClient(config);

 // Post a log whose level is 'info' and message is 'foo bar hoge'
 client.level('info').logger("foo bar hoge", function (err, result) {
   console.log("result: ", result);
 });

Wanna grab logs?

 // Load giraffi
 var giraffi = require('giraffi');

 // Configure your applog server
 var config = {
   host: "localhost:3000",
   ssl: false
 };

 // Create a client object and start retrieving logs
 var client = giraffi.createClient(config);

 // Retrieve '5' logs whose level is 'info' and message contains the string 'foo'
 client.level('info').limit(5).retrieve('foo', function (err, results) {
   console.log("results: ", results);
 });

Please see example/logger.js and example/logger-with-no-callback.js for how to post logs and example/retrieve.js for how to get logs.

Run tests

You must run an applog server on your local port 3000 or other (please edit test/fixtures/test-config.json) before running tests. All of the tests are written in Vows.

 npm test giraffi

Thanks

node-giraffi is written in JavaScript and heavily inspired by node-loggly.
Node Ninja handles logging for users' dev activities using node-giraffi.

Something went wrong with that request. Please try again.