https://github.com/uber/airlock

A prober to probe HTTP based backends for health
https://github.com/uber/airlock

Last synced: 8 months ago
JSON representation

A prober to probe HTTP based backends for health

• Host: GitHub
• URL: https://github.com/uber/airlock
• Owner: uber
• License: mit
• Created: 2013-12-06T18:54:10.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2020-05-01T22:43:29.000Z (almost 6 years ago)
• Last Synced: 2025-05-24T16:01:28.224Z (10 months ago)
• Language: JavaScript
• Homepage:
• Size: 33.2 KB
• Stars: 47
• Watchers: 2,727
• Forks: 9
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# airlock

A prober to probe HTTP, [tchannel](https://github.com/uber/tchannel), or potentially other protocols based backends for health

## Example

```js

var Prober = require("airlock")

var prober = new Prober({

    title: 'probe interface',

    statsd: { increment: function (key) {

        // send increment command to a statsd server.

    } },

    logger: {

        warn: function (message) {

            /* sink this message to your logging system */

        }

    }

})

var thunk = request.bind(null, {

    uri: 'http://www.example.com/foo',

    method: 'POST',

    json: { ... }

})

prober.probe(thunk, function (err, res, body) {

    /* we probed the async task and have the result

        if the async task fails a lot then the prober

        automatically rate limits

    */

})

```

## Installation

`npm install airlock`

## Contributors

 - Raynos

 - markyen

 - jwolski

 - zhijinli

## MIT Licenced