purrf v2.1.4

Purrf

A simple utility to track asset and network performance.

npm install purrf

What is Purrf?

Purrf utilizes the Permormance browser API to reveal metrics on resource performance and log them in AWS CloudWatch.

Usage

1. Install

npm i -S purrf

2. Usage

Import Purrf from npm and initialize a new instance.

import Purrf from 'purrf';

new Purrf();

You can also install Purrf from a CDN.

<script src="https://unpkg.com/purrf"></script>

<script>
    new Purrf();
</script>

You can optionally configure Purrf to suit your needs.

new Purrf({
    includes: [
        '.js'
    ]
});

In order to log the metrics to CloudWatch you'll need to pass in your AWS credentials to your instance of Purrf.

new Purrf({
    config: {
        region: 'us-west-1',
        logGroup: '/your/log/group',
        logStream: 'your-log-stream',
        accessKeyId: process.env.AWS_ACCESS_KEY_ID,
        secretAccessKey: process.env.AWS_SECRET_ACCESS_KEY
    }
})

API Reference

Purrf takes the following arguments on intitialization.

includes: <string[]> - An array of strings to include. If this option exists, Purrf will only track resources that match or include items from this list. excludes: <string[]> - An array of strings to exclude. If this option exists, Purrf will not track resources that match or include items from this list. config: <object> - An object with your CloudWatch details and AWS credentials.