README.md

Firefox Profiler development docs

profiler.firefox.com is a client for reading profiles from the profiler component built inside of Firefox, known as the Gecko Profiler. It also can read in formats from a variety of sources. The front-end client is written using JavaScript and Flow types using React for the UI components and Redux for the state management. Firefox can interact with this client by directly injecting profiles into the webpage via a WebChannel mechanism. This code lives in Mozilla Central under devtools/client/performance-new

The Docs

• Firefox Profiler src docs
  • Redux action creators - /src/actions
  • React components - /src/components
  • Manipulating and processing profiles - /src/profile-logic
  • Redux reducers - /src/reducers
  • Redux selectors- /src/selectors
  • Testing - /src/test
    • React component testing
    • Redux store testing
    • Unit testing
  • Flow types - /src/types
  • Utility files - /src/utils
• Profiler architecture
• Loading in profiles from various sources
• Gecko profile format
• Processed profile format
• Writing a Custom Profile Importer
• Markers
• Profile expiration and upgrading profiles
• Potential performance data sources in Gecko
• Call tree
• Frames, funcs, stacks and CallNodes in C++
• Deploying to production
• Symbolication