react-latency-collector
Wrapper around React.Component that measures component render times.
This is highly influenced by Eric Bidelman's (@ebidel) appmetrics.js which can be found here: https://github.com/ebidel/appmetrics.js
Install
npm install --save react-latency-collector
How to Use
The react-latency-collector component will automatically measure render time and output the results to either the console and/or to whatever data store you define. It is meant to be used as a replacement for react.Component so you don't need to set up a new latency collector for every single one of your components. Use this exactly as you would react.Component
;; Component { superprops <OPTIONAL METRIC LABEL> <OPTIONAL LOG LEVEL> <OPTIONAL ANALYTICS PUBLISHER>; } ...;
Alternatively, you can use the latency collector itself without the wrapper component.
;; Component { superprops; thislatencyCollector = <METRIC LABEL> <LOG LEVEL>; thislatencyCollectorstart; } { thislatencyCollector; thislatencyCollector; thislatencyCollector; } { ... } { ... }
Optional Constructor Arguments
Metric Label
The default metric label is "_render_latency".
Log Level
The log level hierarchy is as follows:
- debug
- warn
- error
- off
Analytics Publisher
You can provide a callback for the react-latency-collector to call. The callback must accept 2 arguments
- The Metric Label
- The Latency value (ms)