{"repo":"sumup-oss/signal","free":true,"listed":false,"github":"https://github.com/sumup-oss/signal","clone":"git clone https://github.com/sumup-oss/signal.git","description":"Collect and send page performance metrics with ease","language":"TypeScript","stars":11,"topics":["sumup","performance","metrics"],"license":"Apache-2.0","category":"analytics","readme_excerpt":"Signal Collect and send page performance metrics with ease Table of contents - What is it - Installation - Configuration - Usage - Events - Customization - Browser compatibility - Code of Conduct - Maintainers - About SumUp What is it Signal is a script that collects specific page performance events and sends them to a configurable service url. Installation At the moment Signal is distributed as a script . Meaning you have to build your own version and embed it in your web page. In order to build your version of it, follow these steps: Clone the repo using SSH Or using https Run Copy the .env.example to .env : The .env file contains the following values: Service url (mandatory) The url where events will be send to Application name (optional) This is app's identifier and is useful when you have more than one application which is sending events Performance observer metrics (optional) You can configure which metrics supported by PerformanceObserver you want to track by specifying them in comma-separated list. Please keep in mind that these 6 metrics are included by default: - first-paint - first-contentful-paint - largest-contentful-paint - first-input-delay - cumulative-layout-shift - time-to-first-byte In the example below custom user metrics are enabled additionally to the default FCP and FID metrics - Usage Now you are ready to build the script. If you want to customize the events, please refer to Customization. In order to generate the script, run Copy the output from build","default_branch":null,"files":null,"tree":[],"storefront":"/r/sumup-oss","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/sumup-oss/signal/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}