# airlock

> A prober to probe HTTP based backends for health

Latest version **2.3.0** (published 2016-07-27) · 0 weekly downloads

## Install

```sh
npm install airlock
pnpm add airlock
yarn add airlock
bun add airlock
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.3.0 |
| Published | 2016-07-27 |
| First published | 2013-12-19 |
| Weekly downloads | 0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 48 |
| Author | Raynos |
| Maintainers | markyen, raynos, uber |

## Links

- npm: https://www.npmjs.com/package/airlock
- Repository: https://github.com/uber/airlock
- Issues: https://github.com/uber/airlock/issues
- npm.io page: https://npm.io/package/airlock

## Recent versions

- 2.3.0 (latest) — 2016-07-27
- 2.2.0 — 2016-07-26
- 2.1.2 — 2016-03-29
- 2.1.1 — 2015-03-20
- 2.1.0 — 2014-06-11
- 2.0.1 — 2014-06-09
- 2.0.0 — 2014-06-05
- 1.0.4 — 2014-01-07
- 1.0.3 — 2013-12-19

## 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

## MIT Licenced

---
_Source: https://npm.io/package/airlock · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._