Implement statsd metrics

Author: matejkramny

README.md

@@ -1,9 +1,29 @@
-ng-fs
-=====
+
+Filesystem API
+==============
 
 Filesystem API server
 
-Test
-----
+Requires `Authorization: <token>` header for every request.
+
+Supported Methods:
+
+- `GET /my-file.txt` - Get contents of my-file.txt
+- `POST /my-file.txt` - Create my-file.txt with request body
+- `PUT /my-file.txt` - Update my-file.txt with request body
+- `DELETE /my-file.txt` - Delete my-file.txt
+
+Provides metrics for requests to a statsd server. Configurable via environment variables.
+
+See `lib/config.js` for specifics.
+
+Tests
+-----
 
 `npm test`
+
+Todo
+----
+
+- Synchronise files across filesystem nodes..
+- Provide timing metrics to statsd

bin/fs-api

@@ -0,0 +1,2 @@
+
+require('../lib/fs-api.js');

lib/config.js

@@ -0,0 +1,9 @@
+exports.credentials = {
+	port: process.env.PORT || 8000,
+	files: process.env.FILES_DIR || "../files",
+	auth: process.env.AUTH || "ng-fs",
+	statsd_ip: process.env.STATSD_IP || "",
+	statsd_port: process.env.STATSD_PORT || 8125
+}
+
+exports.metrics = new (require('lynx'))(exports.credentials.statsd_ip, exports.credentials.statsd_port);

lib/credentials.json

@@ -2,21 +2,33 @@ var http = require('http'),
 	fs = require('fs'),
 	formidable = require('formidable'),
 	path = require('path'),
-	credentials = require('../lib/credentials'),
 	spawn = require('child_process').spawn,
-	async = require('async');
+	async = require('async'),
+	config = require('./config');
 
 http.createServer(function (req, res) {
-	if (!req.headers['authorization'] || req.headers['authorization'] != credentials.auth) {
+	if (!req.headers['authorization'] || req.headers['authorization'] != config.credentials.auth) {
+		config.metrics.increment('fs_api.requests.failed.'+req.headers['authorization']);
+		
 		res.writeHead(401);
 		res.end();
 
 		return;
 	}
 
-	var filePath = path.join(credentials.files, path.normalize(req.url));
+	var filePath = path.join(config.credentials.files, path.normalize(req.url));
 	var method = req.method.toLowerCase();
 
+	// todo config.metrics.timing (would need hooks on response end.)
+	config.metrics.increment('fs_api.requests.'+method);
+
+	if (method == 'head') {
+		res.writeHead(501);
+		res.end();
+
+		return;
+	}
+
 	if (method == 'post' || method == 'put') {
 		var mkdirp = spawn('mkdir', ['-p', filePath]);
 		mkdirp.on('close', function () {
@@ -69,6 +81,6 @@ http.createServer(function (req, res) {
 		stream.pipe(res);
 		return;
 	}
-}).listen(credentials.port);
+}).listen(config.credentials.port);
 
-console.log('HTTP server listening to', credentials.port);
+console.log('HTTP server listening to', config.credentials.port);

bin/fs-api.js renamed to lib/fs-api.js

@@ -1,17 +1,17 @@
 var request = require('supertest');
 var http = require('http');
 var should = require('should');
-var credentials = require('../lib/credentials');
+var config = require('../lib/config');
 
 require('../bin/fs-api');
 
-request = request('http://127.0.0.1:'+credentials.port);
+request = request('http://127.0.0.1:'+config.credentials.port);
 
 describe('delete', function () {
 	it('post file', function (done) {
 		request
 			.post('/a/b/c')
-			.set('Authorization', credentials.auth)
+			.set('Authorization', config.credentials.auth)
 			.attach('todelete.txt', 'test/fixtures/test.txt')
 			.expect(201)
 			.end(function(err, res) {
@@ -23,15 +23,15 @@ describe('delete', function () {
 	it('deletes the file', function (done) {
 		request
 			.delete('/a/b/c/todelete.txt')
-			.set('Authorization', credentials.auth)
+			.set('Authorization', config.credentials.auth)
 			.expect(201)
 			.end(done);
 	});
 
 	it('gets 404', function (done) {
 		request
 			.get('/a/b/c/todelete.txt')
-			.set('Authorization', credentials.auth)
+			.set('Authorization', config.credentials.auth)
 			.expect(404)
 			.end(done)
 	})

test/delete.js

@@ -1,17 +1,17 @@
 var request = require('supertest');
 var http = require('http');
 var should = require('should');
-var credentials = require('../lib/credentials');
+var config = require('../lib/config');
 
 require('../bin/fs-api');
 
-request = request('http://127.0.0.1:'+credentials.port);
+request = request('http://127.0.0.1:'+config.credentials.port);
 
 describe('get', function () {
 	it('gets 404', function (done) {
 		request
 			.get('/nonexisting/file.txt')
-			.set('Authorization', credentials.auth)
+			.set('Authorization', config.credentials.auth)
 			.expect(404)
 			.end(done);
 	});

test/get.js

@@ -1,17 +1,17 @@
 var request = require('supertest');
 var http = require('http');
 var should = require('should');
-var credentials = require('../lib/credentials');
+var config = require('../lib/config');
 
 require('../bin/fs-api');
 
-request = request('http://127.0.0.1:'+credentials.port);
+request = request('http://127.0.0.1:'+config.credentials.port);
 
 describe('post', function () {
 	it('post file', function (done) {
 		request
 			.post('/a/b/c')
-			.set('Authorization', credentials.auth)
+			.set('Authorization', config.credentials.auth)
 			.attach('test.txt', 'test/fixtures/test.txt')
 			.expect(201)
 			.end(function(err, res) {
@@ -23,7 +23,7 @@ describe('post', function () {
 	it('gets back the file', function (done) {
 		request
 			.get('/a/b/c/test.txt')
-			.set('Authorization', credentials.auth)
+			.set('Authorization', config.credentials.auth)
 			.expect(200)
 			.expect('hello there!')
 			.end(done);