https://github.com/facebook/FBMemoryProfiler

iOS tool that helps with profiling iOS Memory usage.
https://github.com/facebook/FBMemoryProfiler

Last synced: about 2 months ago
JSON representation

iOS tool that helps with profiling iOS Memory usage.

• Host: GitHub
• URL: https://github.com/facebook/FBMemoryProfiler
• Owner: facebookarchive
• License: other
• Archived: true
• Created: 2016-04-07T18:24:13.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2020-04-25T15:58:50.000Z (over 4 years ago)
• Last Synced: 2024-04-08T00:14:51.061Z (5 months ago)
• Language: Objective-C
• Size: 1.75 MB
• Stars: 3,413
• Watchers: 140
• Forks: 400
• Open Issues: 20
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# FBMemoryProfiler

[![Carthage compatible](https://img.shields.io/badge/Carthage-compatible-4BC51D.svg?style=flat)](https://github.com/Carthage/Carthage)

[![CocoaPods](https://img.shields.io/cocoapods/v/FBMemoryProfiler.svg?maxAge=2592000)]()

An iOS library providing developer tools for browsing objects in memory over time, using [FBAllocationTracker](https://github.com/facebook/FBAllocationTracker) and [FBRetainCycleDetector](https://github.com/facebook/FBRetainCycleDetector).

## About

This library shows how `FBAllocationTracker` and `FBRetainCycleDetector` can cooperate together, and how they can be used in real app.

It uses [FBAllocationTracker](https://github.com/facebook/FBAllocationTracker) to gather information about the objects. 

It supports [generations](https://github.com/facebook/FBAllocationTracker#generations) and [retain cycle detection](https://github.com/facebook/FBRetainCycleDetector).

Here is a small demo (project is [available in Example directory](Example/))



## Installation

### Carthage

To your Cartfile add: 

    github "facebook/FBMemoryProfiler"

`FBMemoryProfiler` is built out from non-debug builds, so when you want to test it, use 

    carthage update --configuration Debug

### CocoaPods

To your podspec add:

    pod 'FBMemoryProfiler'

You'll be able to use `FBMemoryProfiler` fully only in `Debug` builds. This is controlled by [compilation flag](FBMemoryProfiler/FBMemoryProfiler.h#L29) that can be provided to the build to make it work in other configurations.

## Usage

To start using `FBMemoryProfiler` you'll first need to enable `FBAllocationTracker`.

```objc

#import 

int main(int argc, char * argv[]) {

  [[FBAllocationTrackerManager sharedManager] startTrackingAllocations];

  [[FBAllocationTrackerManager sharedManager] enableGenerations];

  @autoreleasepool {

      return UIApplicationMain(argc, argv, nil, NSStringFromClass([AppDelegate class]));

  }

}

```

To enable memory profiler:

```objc

#import 

FBMemoryProfiler *memoryProfiler = [FBMemoryProfiler new];

[memoryProfiler enable];

// Store memory profiler somewhere to extend it's lifetime

_memoryProfiler = memoryProfiler;

```

`FBMemoryProfiler` will show up as a button on the screen. Once tapped, it will open memory profiler in full size mode.

We can also define plugins (check below) and [filters for retain cycle detector](https://github.com/facebook/FBRetainCycleDetector#filters), that we pass to configuration.

```objc

_memoryProfiler = [[FBMemoryProfiler alloc] initWithPlugins:@[[IncredibleCacheCleaningPlugin new],

                                                              [AwesomeLoggerPlugin new]]

                           retainCycleDetectorConfiguration:someConfigurationWithCustomFilters];

[_memoryProfiler enable];

```

## Plugins

Plugins are objects that conform to [FBMemoryProfilerPluggable](FBMemoryProfiler/Options/FBMemoryProfilerPluggable.h) protocol. Example usage: [custom cache cleaners](Example/ExampleApp/CacheCleanerPlugin.h), [loggers that log data to server](Example/ExampleApp/RetainCycleLoggerPlugin.h).

## Contributing

See the [CONTRIBUTING](CONTRIBUTING.md) file for how to help out.

## License

See (LICENSE)