https://github.com/Flagsmith/react-native-performance-monitor

React Native Performance Monitor - Realtime graphing of React Native render performance
https://github.com/Flagsmith/react-native-performance-monitor

monitoring performance react react-components react-native react-native-component

Last synced: 3 months ago
JSON representation

React Native Performance Monitor - Realtime graphing of React Native render performance

• Host: GitHub
• URL: https://github.com/Flagsmith/react-native-performance-monitor
• Owner: Flagsmith
• Created: 2020-02-10T20:54:35.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-02T16:57:50.000Z (over 1 year ago)
• Last Synced: 2024-05-07T20:03:03.940Z (6 months ago)
• Topics: monitoring, performance, react, react-components, react-native, react-native-component
• Language: JavaScript
• Homepage: https://react-native-performance-monitor-orpin.now.sh
• Size: 19.4 MB
• Stars: 356
• Watchers: 6
• Forks: 13
• Open Issues: 20
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


# React Native Performance Monitor



This project lets you see a realtime graph of render times within your React Native app. The purpose is for you to be able to create experiments (i.e. change markup and see how it affects render times).

# Installation

```

npm i react-native-performance-monitor --save

npx react-native-performance-monitor get

```

# Usage

```

import withPerformanceMonitor from 'react-native-performance-monitor/provider';

export default withPerformanceMonitor({WrappedComponent: YourScreen, id: 'Screen Name'});

```

# An example

Set your baseline at http://127.0.0.1:8125/ by clicking remount. Pause the recorder, and adjust your component with what you think will improve performance.

Here's a before and after with this approach

Baseline

```

    {this.props.children}

```

Improved

```

    {this.props.children}

```

With this before and after I observed the following within a large flat list. 



# Connecting to a real device

In order to connect to a real device you will need to set the IP of your computer, for example:

```

export default withPerformanceMonitor({ WrappedComponent: AwesomeChat, id: 'AwesomeChat', ip: '192.168.1.10'});

```

By default the server is listening on port 8125 for event updates and 8126 for websocket.

If you need to configure the port, because you are tunneling your request or similar, and or disable the Websocket communication, you can do it like this:

```

export default withPerformanceMonitor({WrappedComponent: AwesomeChat, id: 'AwesomeChat', ip: '192.168.1.10', events: undefined, showLogs: undefined, port: 80, enableWS: false});

```

# How it works

The overall implementation is quite straight forward and simply involved passing the onRenderCallback values via a websocket server to finally render them in a fancy graph.

There are 3 main components:

- A [React Native component](https://github.com/BulletTrainHQ/react-native-performance-monitor/blob/master/lib/provider.js) that sends profile data to a server via REST and listens to messages (remount and forceUpdate) to trigger renders.

- A [Web socket server](https://github.com/BulletTrainHQ/react-native-performance-monitor/blob/master/lib/src/server.js) responsible for passing messages between the graph and the react native component

- A [Web application](https://github.com/BulletTrainHQ/react-native-performance-monitor/blob/master/components/App.js) that receives websocket values and renders them to a graph

The following diagram is a brief explanation of the data flow:



## Contributing

Please read [CONTRIBUTING.md](https://gist.github.com/kyle-ssg/c36a03aebe492e45cbd3eefb21cb0486) for details on our code of conduct, and the process for submitting pull requests to us.

## Useful links

[Website](https://www.flagsmith.com/)

[Documentation](https://docs.flagsmith.com/)