# http-metrics

[![npm](https://img.shields.io/npm/v/hmetrics.svg)](https://www.npmjs.com/package/hmetrics)
[![Build Status](https://travis-ci.org/upyun-dev/http-metrics.svg)](https://travis-ci.org/upyun-dev/http-metrics.svg)
[![Dependency Status](https://david-dm.org/upyun-dev/http-metrics.svg)](https://david-dm.org/upyun-dev/http-metrics)
[![Coverage Status](https://coveralls.io/repos/github/upyun-dev/http-metrics/badge.svg?branch=master)](https://coveralls.io/github/upyun-dev/http-metrics?branch=master)
[![devDependency Status](https://david-dm.org/upyun-dev/http-metrics/dev-status.svg)](https://david-dm.org/upyun-dev/http-metrics#info=devDependencies)
[![Codacy Badge](https://api.codacy.com/project/badge/Grade/cc2214862f0c4939ba5f4adef8c75037)](https://www.codacy.com/app/shanderlam/http-metrics)

Make HTTP/HTTPS display information on callback after a completed transfer.

The variables available are:

* `time_namelookup` The time, in seconds, it took from the start until the name resolving was completed.
* `time_appconnect` The time, in seconds, it took from the start until the SSL/SSH/etc connect/handshake to the remote host was completed.
* `time_connect` The time, in seconds, it took from the start until the TCP connect to the remote host (or proxy) was completed.
* `time_starttransfer` The time, in seconds, it took from the start until the first byte was just about to be transferred. This includes time_pretransfer and also the time the server needed to calculate the result.
* `time_total` The total time, in seconds, that the full operation lasted. The time will be displayed with millisecond resolution.
* `size_download` Number of bytes downloaded.
* `status_code` HTTP response status code.

## Installation

> $ npm install hmetrics

## Usage

### request(options, cb)

`options` can be an object or a string. All options from [http](https://nodejs.org/dist/latest-v5.x/docs/api/http.html#http_http_request_options_callback)/[https](https://nodejs.org/dist/latest-v5.x/docs/api/https.html#https_https_request_options_callback) are valid.

extra-options:

- timeout
  set maximum time the request is allowed to take
- connect_timeout
  timeout for the connect phase

example:

```javascript
// http request
var q = require('hmetrics');
q.request({
  hostname: 'www.sina.com.cn',
  port: 80,
  path: '/',
  method: 'GET',
  timeout: 10,
  connect_timeout: 5
}, function(err, data) {
  if (err) return console.log(err);
  console.log(data);
});
/**
 * { time_namelookup: 0.012,
 *   time_total: 0.036,
 *   time_appconnect: 0,
 *   time_connect: 0.018,
 *   time_starttransfer: 0.032,
 *   size_download: 298816,
 *   status_code: 200 }
 */

// https request
var q = require('hmetrics');
q.request('https://www.baidu.com', function(err, data) {
  if (err) return console.log(err);
  console.log(data);
});
/**
 * { time_namelookup: 0.021,
 *   time_starttransfer: 0.065,
 *   time_total: 0.067,
 *   time_appconnect: 0.053,
 *   time_connect: 0.032,
 *   size_download: 298816,
 *   status_code: 200 }
 */

// http request timeout
var q = require('hmetrics');

q.request({
  hostname: 'www.sina.com.cn',
  port: 80,
  path: '/',
  method: 'GET',
  timeout: 10,
  connect_timeout: 0.0001
}, function(err, data) {
  if (err) return console.log(err);
  console.log(data);
});
/**
 * [Error: request timeout]
 */
```