bedrockstreaming/httptostatsd

A node.js http to statsd logger

HttpToStatsd

An HTTP server in node.js for receiving client metrics and send them to statsD.

Native apps, and client side apps, can't easily send UDP packet directly to StatsD. With this server, you can send to it, asynchronous http request, from client-side apps, letting the server send them in UDP to your statsD.

installation

yarn

... profit !

usage in production

node app

or if you want to choose the port (to run multiple instance) :

export NODE_PORT=8081 && node app

usage in dev (loading dev config)

export NODE_ENV=development
node app

usage in production (loading production config)

export NODE_ENV=production
node app

increment

/statsd/:node/increment?token=xxx
/statsd/:node/increment/:delta?token=xxx

example

/statsd/raoul/increment?token=xxx
/statsd/raoul/increment/123?token=xxx

delta value specifies by how much counter is modified

timer

/statsd/:node/timer/:timing?token=xxx

gauge

/statsd/:node/gauge/:gauge?token=xxx

example

/statsd/raoul/timer/234?token=xxx

timing value in ms

how to compute a token

md5sum(node + value + secretKey)

for increment, value is '1'

Rate limit

    "rateLimit": {
        "enable": true,
        "lookup": [
            "connection.remoteAddress"
        ],
        "maxRequestsPerSeconds": 100,
        "expire": 60,
        "skipHeaders": true
    }

• enable: Boolean enable/disable rate limit feature
• lookup: String|Array.<String> value lookup on the request object. Can be a single value or array.
• maxRequestsPerSeconds: Number allowed number of requests before getting rate limited
• expire: Number amount of time in s before the rate-limited is reset (global reset)
• skipHeaders: Boolean whether to skip sending HTTP X-Ratelimit headers for rate limit

Launch unit test

yarn test

httptostatsd's Issues

add Gauge to HttpToStatsd

token sent and token build should be compared using upperCase

I got errors due to token comparisons line 23 in 'lib/security/securitytokenchecker.js'

IMHO both values should be compared once set to upperCase to avoid errors due to char value

README

Is it possible to write the README file ?
We don't even know what it's about 😄

httpToStatsd implementation

Hello
I ask myself about the best way to implement httpToStatsd in a project.
In my case my architecture is i think classical :

• A backend server with Statsd and a database (InfluxDb here)
• A frontend with a node app (splitted in two parts client and server) and Nginx as a proxy to not expose the app.

Then i want to allow external applications/systems/whatever to send metrics to statsd. Then i guess that the best place to install httpToStatsd is to put it on the frontend server using Nginx as a proxy also.

Can you please confirm that i'm on the good way ?