https://github.com/bbc/http-transport-emf-stats

An http-transport plugin that adds stats information about the upstream request/response, errors, cache events etc. This plugin can be used in combination with CloudWatch EMF.
https://github.com/bbc/http-transport-emf-stats

aws emf http http-transport https sounds sounds-web statistics stats

Last synced: 2 days ago
JSON representation

An http-transport plugin that adds stats information about the upstream request/response, errors, cache events etc. This plugin can be used in combination with CloudWatch EMF.

• Host: GitHub
• URL: https://github.com/bbc/http-transport-emf-stats
• Owner: bbc
• License: apache-2.0
• Created: 2020-07-15T08:18:55.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2021-07-29T09:17:47.000Z (over 3 years ago)
• Last Synced: 2024-04-08T21:02:40.446Z (7 months ago)
• Topics: aws, emf, http, http-transport, https, sounds, sounds-web, statistics, stats
• Language: JavaScript
• Homepage:
• Size: 92.8 KB
• Stars: 0
• Watchers: 6
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
[![BBC](https://circleci.com/gh/bbc/http-transport-emf-stats.svg?style=shield)](https://app.circleci.com/pipelines/github/bbc/http-transport-emf-stats?branch=master)

* [Installation](#installation)

* [Usage](#usage)

* [Stats](#stats)

* [Testing and linting](#testing-and-linting)

# HTTP transport EMF stats

EMF stats is a plugin that can be used by [http-transport](https://github.com/bbc/http-transport) to return a stats object alongside the HTTP response.

## Installation

```bash

npm install @bbc/http-transport-emf-stats

```

or

```bash

yarn add @bbc/http-transport-emf-stats

```

## Usage

```js

import HttpTransport from '@bbc/http-transport';

const client = HttpTransport

  .createBuilder()

  .userAgent('...')

  .retries(...)

  .retryDelay(...)

  .use(stats())

  .createClient();

```

**With the cache enabled**

Used in conjunction with [@bbc/http-transport-cache](https://github.com/bbc/http-transport-cache)

```js

import HttpTransport from '@bbc/http-transport';

import { maxAge, staleIfError } from '@bbc/http-transport-cache';

const catbox = ...; // a catbox instance

const cacheOpts = {

  name: 'rms',

  ...

  ...

}

const client = HttpTransport

  .createBuilder()

  .userAgent('...')

  .retries(...)

  .retryDelay(...)

  .use(stats())

  .use(maxAge(catbox, cacheOpts))

  .use(staleIfError(catbox, cacheOpts))

  .createClient();

```

## Stats

The stats object is structured as following:

```js

{

  metrics: {

    attemptCount: 0, // The number of request attempts in total. This number is equal to "attempts.length".

    retryCount: 0, // The number of retried attempts. This number is equal to "attemptCount - 1".

    requestCount: 0, // The number of times a request is sent to and a response is received from the upstream

    requestErrorCount: 0, // The number of times the upstream service doesn't respond

    response5xxCount: 0, // The number of 5xx responses

    response4xxCount: 0, // The number of 4xx responses

    response3xxCount: 0, // The number of 3XX responses

    response2xxCount: 0, // The number of 2XX responses

    response1xxCount: 0, // The number of 1XX responses

    responseInvalidCount: 0, // The number of invalid response statuses

    responseTime: 0,

    cacheHitCount: 0,

    cacheMissCount: 0,

    cacheStaleCount: 0,

    cacheErrorCount: 0,

    cacheTimeoutCount: 0,

    cacheConnectionErrorCount: 0

  },

  cacheAudit: [] // A list of cache events triggered by the cache plugin. It is used for troubleshooting purposes only.

}

```

The `stats` object is set within `res` when the request resolves or in the error object when it rejects. If you want to access the stats info do as following:

```js

try {

  const response = await client.get(uri).asResponse();

  const { stats } = response.res;

  // can access stats data

} catch (error) {

  const { stats } = error;

  // can access stats data

}

```

## Testing and linting

To run unit tests and coverage reports

```

npm run test

```

or just tests without coverage report

```

npm run test:only

```

To run code linting

```

npm run lint

```