Giter Club home page Giter Club logo

react-native-perf-logger's Introduction

react-native-perf-logger

background

This library created to enable production measurement of your react native application.

  • In the first phase (based on Parashuram's blog: React Native Performance Playbook) - I tried to measure the duration of app's startup time.
  • On the way, allow measurement of memory consumption, battery consumption and other footprints of your application.

Getting started

$ npm install react-native-perf-logger --save

Manual installation

iOS

[ WIP]

  1. In XCode, in the project navigator, right click LibrariesAdd Files to [your project's name]
  2. Go to node_modulesreact-native-perf-logger and add PerfLogger.xcodeproj
  3. In XCode, in the project navigator, select your project. Add libPerfLogger.a to your project's Build PhasesLink Binary With Libraries
  4. Run your project (Cmd+R)<

Android

  1. Open up android/app/src/main/java/[...]/MainApplication.java
  • Add import statements
import com.reactnativeperflogger.PerfLoggerPackage; 
import com.reactnativeperflogger.RNPerfLogger;

to the imports at the top of the file

  • Add private RNPerfLogger perfLogger
  • Add perfLogger = new RNPerfLogger(); to the first line of onCreate() method:
@Override
public void onCreate() {
  perfLogger = new RNPerfLogger();
  super.onCreate();
  ...
}
  • Add new PerfLoggerPackage(perfLogger) to the list returned by the getPackages() method
  1. Append the following lines to android/settings.gradle:
    include ':react-native-perf-logger'
    project(':react-native-perf-logger').projectDir = new File(rootProject.projectDir, 	'../node_modules/react-native-perf-logger/android')
    
  2. Insert the following lines inside the dependencies block in android/app/build.gradle:
      compile project(':react-native-perf-logger')
    

Usage

  1. Add a prop nativeID to the last view of the first screen of every loading flow of your application.
  render() {
    return (
      <FlatList
        ...
        id={'HOME_SCREEN_LIST'}
        nativeID="myHomeScreen"
      />
    );
  }
  1. Register all such nativeIDs with
// you can register for multiple ids
const ids = ["myHomeScreen"]; 
PerfLogger.registerTTINativeIds(ids);
  1. Register to TTI completed event, and get the JSON includes all the recorded markers:
import PerfLogger from 'react-native-perf-logger';
    PerfLogger.registerTTICompletedListener(async (id: string, time: string) => {
      console.log(`tti_complete time: ${time}`);
      const result = await PerfLogger.getAllMarkers();
      
      // you can use alternatively PerfLogger.getIntervalBounds()
      // to get start and end time of all completed interval measurements 
      
      console.log(result);
    });
  }
  1. Do whatever you want with the result (send to your server, send bi..)
  2. To force the logger stop listening to events and remove all stored data use:
PerfLogger.stopAndClear();

react-native-perf-logger's People

Contributors

bruchim avatar evgeni-wix avatar jasminmif avatar niryo avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

Forkers

niryo teamguilded

react-native-perf-logger's Issues

The data is not visible on Chrome tracing

Hi @bruchim!

I saw your talk at React NativeEU(it was inspiring and awesome by the way) and interested in testing out perf logger to monitor TTI.
I was successfully able to generate perf data but I'm having trouble seeing the result. When I load the data on chrome://tracing it does not load the result.

Here's the data I generated using react-native-perf-logger.
https://gist.github.com/tomoima525/ae5a6d38fcb0b6b2de36965b411d2f2a

I would appreciate it if you can give me any advice to view the result properly(tools that I can use).
The RN version I'm currently using is 0.61.5

Thank you in advance!

Not compatible with react-native@"0.64.2"

As a project requirement, I have to use "package.json" to install this package.

Our project uses the lates react-native 0.64.2

Running 'npm install' results in an error:

npm ERR! node_modules/react
npm ERR! peer react@"^16.8.1" from [email protected]
npm ERR! node_modules/react-native-perf-logger
npm ERR! react-native-perf-logger@"2.0.1" from the root project
npm ERR!
npm ERR! Could not resolve dependency:
npm ERR! peer react@"17.0.1" from [email protected]
npm ERR! node_modules/react-native
npm ERR! react-native@"0.64.2" from the root project
npm ERR! peer react-native@">=0.59.0-rc.0 <1.0.x" from [email protected]
npm ERR! node_modules/react-native-perf-logger
npm ERR! react-native-perf-logger@"2.0.1" from the root project

Your package is depended upon by several other node modules. We simply can't delete it.

Thanks in advance

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.