@shopify/koa-metrics
Aims to provide standard middlewares and instrumentation tooling for metrics in Koa.
Last updated 19 days ago by shopify-dep .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @shopify/koa-metrics 
SYNC missed versions from official npm registry.

@shopify/koa-metrics

Build Status License: MIT npm version

Opinionated performance metric tracking for Koa, implemented with DogStatsD

Installation

$ yarn add @shopify/koa-metrics

Usage

import Koa from 'koa';
import metrics from '@shopify/koa-metrics';

const app = new Koa();

app.use(
  metrics({
    prefix: 'AppName',
    host: 'some-statsd-host.com:8125',
  }),
);

Options

The passed in options object adheres to the following API:

prefix (required)

The global StatsD metric name prefix; should be provided in PascalCase.

host (required)

The url for the StatsD host; should be provided in the format: hostname:port.

API

An instance of the Metrics object will be available on ctx.metrics further down in the middleware stack.

Metrics

.distribution(name: string, value: number, sampleRate?: number, tags?: Tags)

Sends a distribution command with the specified value in milliseconds.

.initTimer(): Timer

Returns a new Timer started at the current process.hrtime()

Timer

.stop(): number

Returns the time, in milliseconds, since the Timer was created.

Tags

tags are an object keyed by the name of the corresponding tag. For example:

{
  name: value,
  name2: value2
}

Intelligent Defaults

The global metric name prefix is provided through the options object.

This package automatically provides performance metrics for HTTP requests.

Standard tags

  • path
  • request_method
  • response_code
  • response_type (eg. 2xx, 3xx, ...)

Default Metrics

request_time

Time to complete a request, from the application perspective.

request_queuing_time

Time before a request actually started being processed.

This metric is emitted when the application start processing a request. It relies on the presence of a header X-Request-Start set by the first HTTP hop.

request_content_length

This metric is based on the response header Content-Length. Some responses don't provide this header (chunked encoding); in those cases, this will not be reported.

Current Tags

  • 0.3.6                                ...           latest (19 days ago)

30 Versions

  • 0.3.6                                ...           19 days ago
  • 0.3.5                                ...           25 days ago
  • 0.3.4                                ...           a month ago
  • 0.3.3                                ...           2 months ago
  • 0.3.2                                ...           2 months ago
  • 0.3.1                                ...           2 months ago
  • 0.3.0                                ...           2 months ago
  • 0.2.9                                ...           3 months ago
  • 0.2.8                                ...           3 months ago
  • 0.2.7                                ...           4 months ago
  • 0.2.6                                ...           5 months ago
  • 0.2.4                                ...           7 months ago
  • 0.2.3                                ...           8 months ago
  • 0.2.2                                ...           8 months ago
  • 0.2.1                                ...           8 months ago
  • 0.2.0                                ...           8 months ago
  • 0.1.14                                ...           a year ago
  • 0.1.13                                ...           a year ago
  • 0.1.12                                ...           a year ago
  • 0.1.10                                ...           a year ago
  • 0.1.9                                ...           a year ago
  • 0.1.8                                ...           a year ago
  • 0.1.7                                ...           a year ago
  • 0.1.6                                ...           a year ago
  • 0.1.5                                ...           a year ago
  • 0.1.4                                ...           a year ago
  • 0.1.3                                ...           a year ago
  • 0.1.2                                ...           a year ago
  • 0.1.1                                ...           a year ago
  • 0.1.0                                ...           a year ago
Downloads
Today 0
This Week 30
This Month 30
Last Day 0
Last Week 0
Last Month 81
Dependencies (3)
Dev Dependencies (4)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |