Trace Compass User Guide
Next
Overview

Table of Contents

  1. Table of Contents
  2. Overview
    1. About Tracing
    2. Features
    3. LTTng integration
  3. Installation
    1. LTTng Tracer
    2. Trace Compass Plug-ins
    3. LTTng Control Dependencies
    4. Installation Verification
  4. Trace Compass Main Features
    1. Tracing Perspective
    2. Project Explorer View
      1. Creating a Tracing Project
      2. Configuring a Project as Tracing Project
      3. Importing Traces to the Project
        1. Opening a Trace
        2. Importing
        3. Drag and Drop
      4. Trace Package Exporting and Importing
        1. Exporting
        2. Importing
      5. Refreshing of Trace and Trace Folder
      6. Remote Fetching
        1. Remote Profile elements
          1. Profile
          2. Connection Node
          3. Trace Group
          4. Trace
        2. Profile editing and management
        3. Selecting remote traces
      7. Selecting a Trace Type
      8. Trace Types Preference Page
      9. Opening a Trace or Experiment
      10. Creating an Experiment
      11. Selecting Traces for an Experiment
      12. Creating an Experiment from Selection
      13. Removing Traces from an Experiment
      14. Deleting Traces from an Experiment
      15. Renaming a Trace or Experiment
      16. Copying a Trace or Experiment
      17. Deleting a Trace or Experiment
      18. Deleting Supplementary Files
      19. Displaying the trace's time range
      20. Link with Editor
      21. Exporting Time Selection as New Trace
    3. Events Editor
      1. Searching and Filtering
        1. Searching
        2. Filtering
        3. Bookmarking
      2. Copy to Clipboard
      3. Event Source Lookup
        1. Source Code
        2. EMF Model
      4. Exporting To Text
      5. Refreshing of Trace
      6. Collapsing of Repetitive Events
      7. Customization
    4. Histogram View
    5. Statistics View
    6. Colors View
    7. Filters View
    8. Time Chart View
    9. State System Explorer View
    10. External Analyses
      1. Running an External Analysis
      2. Opening a Report
      3. Creating a Chart from a Result Table
      4. Showing or Hiding a Result Table
      5. Adding and Removing a User-Defined External Analysis
    11. Custom Parsers
      1. Creating a custom text parser
      2. Creating a custom XML parser
      3. Managing custom parsers
      4. Opening a trace using a custom parser
    12. Pin and Clone
      1. Cloning a view to show two different traces
      2. Cloning a view to show different window ranges of same trace
    13. Time Synchronization of Views
    14. Automatic Time Axis Alignment
    15. Searching in Time Graph Views
      1. Filtering Time Events in Time Graph Views
      2. Filtering of Empty Rows Time Graph Views
    16. Configurable Marker Sets
      1. Marker Set Configuration XML Format
  5. LTTng Tracer Control
    1. Control View
      1. Creating a New Connection to a Remote Host
      2. Disconnecting from a Remote Host
      3. Connecting to a Remote Host
      4. Deleting to a Remote Host Connection
      5. Creating a Tracing Session
      6. Creating a Tracing Session With Advanced Options
      7. Creating a Snapshot Tracing Session
      8. Enabling Channels - General
      9. Enabling Channels On Session Level
      10. Configuring Trace File Rotation
      11. Configuring per UID and per PID Buffers (UST only)
      12. Configuring Periodical Flush for metadata Channel
      13. Enabling Channels On Domain Level
      14. Enabling and Disabling Channels
      15. Enabling Events - General
      16. Enabling Kernel Events On Session Level
      17. Enabling UST Events On Session Level
      18. Enabling JUL Events On Session Level
      19. Enabling LOG4J Events On Session Level
      20. Enabling Python Events On Session Level
      21. Enabling Events On Domain Level
      22. Enabling Events On Channel Level
      23. Enabling and Disabling Events
      24. Enabling Tracepoint Events From Provider
      25. Configuring Filter Expression When Enabling Events
      26. Adding Contexts to Channels and Events of a Domain
      27. Adding Contexts to All Events of a Channel
      28. Adding Contexts to an Event of a Specific Channel
      29. Start Tracing
      30. Recording a Snapshot
      31. Stop Tracing
      32. Destroying a Tracing Session
      33. Refreshing the Node Information
      34. Importing Session Traces to a Tracing Project
      35. Importing Network Traces to a Tracing Project
      36. Saving Tracing Sessions
      37. Loading Tracing Sessions
      38. Managing Tracing Session Profiles
    2. Properties View
    3. LTTng Tracer Control Preferences
  6. LTTng Kernel Analysis
    1. OS Tracing Overview Perspective
    2. LTTng Kernel Perspective
    3. Control Flow View
      1. Process tree and information
      2. Control flow
        1. Using the mouse
        2. Using the keyboard
        3. Incomplete regions
        4. Zoom region
        5. Tooltips
        6. Dynamics Filters
          1. Show Active Threads Only
      3. Toolbar
      4. Marker Axis
    4. Resources View
      1. Follow CPU
      2. Follow thread
      3. Navigation
      4. Incomplete regions
      5. Toolbar
      6. Marker Axis
    5. LTTng CPU Usage View
      1. Process Information
      2. CPU Usage Chart
        1. Tooltips
        2. Using the mouse
        3. Using the keyboard
        4. Toolbar
        5. View Menu
        6. CPU Filtering
    6. Kernel Memory Usage View
      1. Process Information
      2. Navigation
      3. Toolbar
      4. View Menu
      5. Relative Kernel Memory Chart
        1. Navigation
        2. Tooltips
    7. Process Wait Analysis
      1. Prerequisites
      2. Running the analysis
    8. Input/Output Analysis
      1. Get the trace
      2. Input/Output Views
        1. Disk I/O Activity View
        2. Navigation
        3. Toolbar
        4. View Menu
    9. System Call Latency Analysis
    10. Futex Contention Latency Analysis
      1. Uaddr vs Waiter
      2. Scenarios
    11. Latency analysis for IRQ handlers
    12. LTTng Kernel Events Editor
    13. Scheduler wake up/Scheduler switch Latency Analysis
  7. LTTng-UST Analyses
    1. Flame Chart View
      1. Using the Flame Chart View with LTTng-UST traces
      2. Importing a binary or function name mapping file (for LTTng-UST <2.8 traces)
      3. Navigation
      4. Marker Axis
    2. Flame Graph View
      1. How to use a Flame Graph
    3. Function Duration Statistics
      1. Using the mouse
      2. Using the keyboard
      3. Toolbar
      4. Importing a binary or function name mapping file (for LTTng-UST <2.8 traces)
    4. Function Duration Density
    5. Memory Usage
      1. Navigation
      2. Toolbar
      3. View Menu
    6. Source Lookup (for LTTng-UST 2.8+)
      1. Binary file location configuration
  8. Trace synchronization
    1. Obtain synchronizable traces
      1. Use LTTng-modules 2.9+
      2. LTTng-module network tracepoint with complete data
      3. LTTng-modules addons kernel module with dynamic tracepoints
    2. Synchronize traces in Trace Compass
  9. Time offsetting
    1. Basic mode
    2. Advanced mode
    3. Clearing time offset
  10. Timestamp formatting
  11. Data driven analysis
    1. Managing XML files containing analyses
    2. Defining XML components
    3. Defining an XML state provider
      1. Definitions and example
      2. Determining the state system structure
      3. Writing the XML state provider
      4. Debugging the XML state provider
    4. Defining an XML pattern provider
      1. The state system structure
      2. Writing the XML pattern provider
      3. Representing the scenarios
    5. Defining an XML time graph view
      1. Using the keyboard
    6. Defining an XML XY chart
  12. Latency Analyses
  13. Counters Analysis
    1. Creating an LTTng trace with performance counters
    2. Counters View
      1. Navigation
      2. Toolbar
      3. View Menu
  14. Java Logging
    1. Enable JUL Logging
    2. Configuring JUL logging
    3. LTTng JUL log handler
  15. Limitations
  16. How to use LTTng to diagnose problems
    1. Random stutters
    2. Slow I/O
  17. Trace Compass Incubator
  18. References
Next
Overview