SpeedCurve-Metrics / lux.js Public

Notifications You must be signed in to change notification settings
Fork 0
Star 0

Web performance testing (real user monitoring) by SpeedCurve

speedcurve.com/features/lux/

BSD-3-Clause license

0 stars 0 forks Branches Tags Activity

Notifications

Name		Name	Last commit message	Last commit date
Latest commit History 548 Commits
.github/workflows		.github/workflows
docs		docs
src		src
tests		tests
.eslintrc.js		.eslintrc.js
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
LICENSE.txt		LICENSE.txt
README.md		README.md
babel.config.js		babel.config.js
jest.config.js		jest.config.js
package-lock.json		package-lock.json
package.json		package.json
playwright.config.ts		playwright.config.ts
rollup.config.mjs		rollup.config.mjs
tsconfig.json		tsconfig.json

Repository files navigation

lux.js - real user monitoring

This repository contains the source code for lux.js, SpeedCurve's real user monitoring (RUM) script.

How to use lux.js

Sign up for a SpeedCurve account
Go to the Settings page and scroll to the bottom of the page
Click on Edit RUM
Click on the JS Snippet tab
Copy the RUM JS snippet into the <head> of your page

⚠️ Self-hosting lux.js is not recommended. Please read our self-hosting documentation for more information.

Configuring lux.js

See the lux.js API documentation.

Using lux.js in a SPA

See the SPA documentation.

Project goals

Browser compatibility - lux.js runs and gathers basic metrics in every browser that supports ES3, while still gathering modern metrics from evergreen browsers.
Small size - lux.js aims to be under 10 KB when minified and compressed.
Low overhead - lux.js creates only a handful of event handlers and observers. Most metrics are calculated on-demand before a beacon is sent.

Local development

Compile the lux.js script with npm run build or npm run watch
Run the tests with npm run test
Check for linting errors with npm run lint and automatically fix them (where possible) with npm run lint-fix

Release process

Propose changes in a pull request
Once approved, merge changes to the main branch
Increment the SCRIPT_VERSION constant on the main branch
Add release information into CHANGELOG.md in this repo
Create a new release in GitHub, following the naming convention and documentation process of previous releases
Run npm run build to generate the lux.js bundles.
Follow the rum-backend release process to deploy the updated lux.js bundles.