https://github.com/trygve-lie/reqspy
A non intrusive request spy - log outgoing http(s) requests from an application.
https://github.com/trygve-lie/reqspy
http metrics monitoring nodejs requests
Last synced: about 1 month ago
JSON representation
A non intrusive request spy - log outgoing http(s) requests from an application.
- Host: GitHub
- URL: https://github.com/trygve-lie/reqspy
- Owner: trygve-lie
- License: mit
- Created: 2020-01-13T14:36:47.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-13T23:10:03.000Z (over 1 year ago)
- Last Synced: 2025-01-08T14:07:02.863Z (about 1 year ago)
- Topics: http, metrics, monitoring, nodejs, requests
- Language: JavaScript
- Homepage:
- Size: 34.2 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ReqSpy
A non intrusive request spy - log outgoing http(s) requests from an application.
## Installation
```bash
$ npm install reqspy
```
## Example
```js
const request = require('request');
const Spy = require('reqspy');
const spy = new Spy();
spy.on('host', (info) => {
console.log('new host requested', info);
});
// Do http requests with any http lib. The Spy will log it.
request('http://api.somewhere.com', (error, response, body) => {
console.log(body);
});
```
## Description
ReqSpy is for logging outgoing http(s) requests from an application in a non intrusive way.
ReqSpy is non intrusive in the way that one do not need to implement it every single place
one do a http(s) call in an application. One only need to init ReqSpy one place in an application
and it will intercept all http(s) calls. When that is said; one can init ReqSpy multiple times if
wanted.
Under the hood ReqSpy use [async hooks](https://nodejs.org/api/async_hooks.html) to intercept
http(s) calls on the net socket level so there is no altering of the global http(s) object in node
or any global singletons.
By using this approach there is a clear separation between the code doing http(s) calls and the
code doing the logging.
Since interaction happen on the net socket, ReqSpy should work out of the box with any node.js
http request library.
## Constructor
Create a new ReqSpy instance.
```js
const Spy = require('reqspy');
const spy = new Spy(options);
```
### options (required)
An Object containing misc configuration. The following values can be provided:
* **hostname** - `String` - The hostname of the application we are logging. Will appear in the output log - `required`
* **metricName** - `String` - Custom name for the metric on the metric stream - `optional`
* **enable** - `Boolean` - Enable interception of http(s) calls upon instansiation of the Spy - `optional`
## API
The ReqSpy instance have the following API:
### .enable()
Enable the spy to intercept http(s) calls. Under the hood this enables the async hook
which does the interception.
### .disable()
Disables the spy from intercept http(s) calls. Under the hood this disables the async
hook which does the interception.
### .metrics
Attribute which holds a [metrics stream](https://github.com/metrics-js/client) that
emits metrics data.
The stream will emit an event of the following character for each request it detects:
```js
{
name: 'requests_outgoing',
description: 'Outgoing requests to downstream HTTP(S) services',
timestamp: 1579468682.531,
type: 2,
value: 1,
labels: [
{ name: 'service', value: 'turing' },
{ name: 'hostname', value: 'github.com' },
{ name: 'address', value: '140.82.118.3' },
{ name: 'family', value: 4 },
{ name: 'error', value: false }
],
time: null,
meta: {}
}
```
Please see [@metrics/client](https://github.com/metrics-js/client) for examples
of consuming these metrics into your favorite monitoring system.
## Events
For each request the ReqSpy instance will emit one of the following events:
### host
Emitted when the ReqSpy encounters a request.
```js
const spy = new Spy(options);
spy.on('host', (info) => {
console.log('new host requested', info);
});
```
## node.js compabillity
This module use [async hooks](https://nodejs.org/api/async_hooks.html) which was first
introdused in node.js 8.1. Despite that, this module will only work fully with node.js
version 10.x or newer.
## License
The MIT License (MIT)
Copyright (c) 2020 - Trygve Lie - post@trygve-lie.com
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.