#@ottrelite/backend-platform

This plugin is the platform-specific backend implementation for RN Ottrelite Core. On Android, it utilizes ATrace (Android tracing API), on iOS it utilizes the OSSignposter API.

#When to use this backend?

This backend is designed for system-level analysis using familiar tools that are already part of your development environment. It leverages the native profiling APIs built into Android and iOS platforms, allowing you to use the debugging tools you're already comfortable with.

Use Platform Backend when you want:

• Familiar tooling - Work with Android Studio Profiler and Xcode Instruments that you already know
• System-level insights - Analyze app performance alongside system metrics and other processes
• No additional setup - Uses built-in platform APIs without requiring external profiling tools

#Supported features

#Installation

To use this package, you need to install it in your React Native project:

npm install @ottrelite/backend-platform

And register the backend with Ottrelite Core in your entrypoint file (e.g. index.js):

import { OttreliteBackendPlatform } from '@ottrelite/backend-platform';
import { Ottrelite } from '@ottrelite/core';

Ottrelite.install([OttreliteBackendPlatform]);

#Recording the trace

#Android

You can record and view traces in two ways:

• using Android Studio's Profiler's 'Capture System Activities' option, as per the documentation; this method works both on physical devices & the Android emulator
• using the perfetto CLI tool, which is distributed as part of the Android OS onboard most modern devices. More details can be found in the documentation; the resulting file can be viewed in Perfetto UI; this method works only on a physical device

#Perfetto CLI

If using the Perfetto CLI via the record_android_trace script, make sure to adjust the --app argument to match your app's package. We discovered that on some devices it is needed to set it, otherwise some userspace events may be missing.

Some devices allow to pass an additional tracing category, app, which can also be considered in such cases. An example invocation might look like the following:

./record_android_trace --app=com.callstack.ottrelite.demo -o trace_file.perfetto-trace -t 40s -b 64mb sched freq idle am wm gfx view binder_driver hal dalvik camera input res memory rs app

#iOS

You can view the traces in Xcode Instruments, as per the documentation.

The traces will be signpost-ed using the OSSignposter API, using the default OS_LOG_DEFAULT logger.