Skip to content

Latest commit

 

History

History
72 lines (56 loc) · 1.8 KB

README.md

File metadata and controls

72 lines (56 loc) · 1.8 KB
Raw

Welcome to statuscake-extractor 👋

Version

This project interrogate Statuscake to fetch pagespeeed data of some shows regularly. Thoses data are exported on Prometheus. A library to take advantage of the API of https://www.statuscake.com/

Get access to this following information:

  • URL
  • Title
  • Loadtime_ms
  • Filesize_kb
  • Requests

Configure

To configure the project, we use npm config package, follow config/default.json.dist example to define yours with:

  • interval (Speedtime is check every second by default)
  • apikey (Imperative to get access to statuscake)
  • username (Imperative to get access to statuscake)
  • baseUrl (Imperative to get access to statuscake)
  • route (Name your route)
  • listener (3000 by default)
  • testTitleFilter (Name of your filter)
  • firstTag (Name of your tag)
  • nameOflLoadTimeGauge (Name of your loadtime gauge)
  • nameOfFileSizeGauge (Name of your filesize gauge)
  • nameOfRequestGauge (Name of your request gauge)
  • tagsFromTestTitleRegexp (Your regex)
  • tags (Your tags)

Debug

Use debug to access to the data, or to check if you got some errors:

DEBUG=statuscake yarn start
DEBUG=error yarn start

If you need more information on this package: https://www.npmjs.com/package/debug

Test

yarn test

If you need more information on this package: https://jestjs.io/docs/en/getting-started

Eslint

yarn lint

Install

yarn install

Usage

Get access to node server with yarn start.

yarn start

This README was generated with ❤️ by readme-md-generator