https://github.com/speedracer/speedmetrics

⏱️Collect meaningful metrics from Chrome's trace events.
https://github.com/speedracer/speedmetrics

Last synced: 2 months ago
JSON representation

⏱️Collect meaningful metrics from Chrome's trace events.

• Host: GitHub
• URL: https://github.com/speedracer/speedmetrics
• Owner: speedracer
• License: mit
• Created: 2018-09-15T14:44:50.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-09-15T20:04:01.000Z (over 6 years ago)
• Last Synced: 2025-01-21T08:24:18.858Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 409 KB
• Stars: 3
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# ![Speedmetrics](https://raw.githubusercontent.com/ngryman/artworks/master/speedmetrics/heading/[email protected])

[![travis][travis-image]][travis-url] [![codecov][codecov-image]][codecov-url]

[travis-image]: https://img.shields.io/travis/speedracer/speedmetrics.svg?style=flat

[travis-url]: https://travis-ci.org/speedracer/speedmetrics

[codecov-image]: https://img.shields.io/codecov/c/github/speedracer/speedmetrics.svg

[codecov-url]: https://codecov.io/github/speedracer/speedmetrics

Collect meaningful metrics from Chrome's trace events.

## Quickstart

### Installation

```sh

npm install speedmetrics

```

### Usage

```js

import collectMetrics from 'speedmetrics'

const metrics = await collectMetrics(trace.traceEvents)

console.log(metrics)

```

```js

{

  timings: {

    navigationStart: 0,

    domContentLoaded: 200,

    firstPaint: 400,

    firstContentfulPaint: 400,

    firstMeaningfulPaint: 600,

    load: 1000

  }

  events: {

    /* ... */

  }

}

```

## API

### collectMetrics(traceEvents)

Accepts a trace events object and return collected metrics.

```js

readFile('trace.json', 'utf8', async (err, data) => {

  const metrics = await collectMetrics(data.traceEvents)

})

```