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. Importing Traces to the Project
        1. Opening a Trace
        2. Importing
        3. Drag and Drop
      3. Trace Package Exporting and Importing
        1. Exporting
        2. Importing
      4. Refreshing of Trace and Trace Folder
      5. 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
      6. Selecting a Trace Type
      7. Opening a Trace or Experiment
      8. Creating a Experiment
      9. Selecting Traces for an Experiment
      10. Removing Traces from an Experiment
      11. Renaming a Trace or Experiment
      12. Copying a Trace or Experiment
      13. Deleting a Trace or Experiment
      14. Deleting Supplementary Files
      15. Link with Editor
    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. Run an External Analysis
      2. Open a Report
      3. Create a Chart from a Result Table
      4. Show or Hide a Result Table
      5. Add and Remove 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. Automatic Time Axis Alignment
    13. Searching in Time Graph Views
  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 Events On Domain Level
      19. Enabling Events On Channel Level
      20. Enabling and Disabling Events
      21. Enabling Tracepoint Events From Provider
      22. Configuring Filter Expression When Enabling Events
      23. Adding Contexts to Channels and Events of a Domain
      24. Adding Contexts to All Events of a Channel
      25. Adding Contexts to an Event of a Specific Channel
      26. Start Tracing
      27. Recording a Snapshot
      28. Stop Tracing
      29. Destroying a Tracing Session
      30. Refreshing the Node Information
      31. Importing Session Traces to a Tracing Project
      32. Importing Network Traces to a Tracing Project
      33. Saving Tracing Sessions
      34. Loading Tracing Sessions
      35. Managing Tracing Session Profiles
    2. Properties View
    3. LTTng Tracer Control Preferences
  6. LTTng Kernel Analysis
    1. LTTng Kernel Perspective
    2. 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
      3. Toolbar
      4. Marker Axis
    3. Resources View
      1. Follow CPU
      2. Navigation
      3. Incomplete regions
      4. Toolbar
      5. Marker Axis
    4. LTTng CPU Usage View
      1. Process Information
      2. CPU Usage Chart
        1. Using the mouse
        2. Tooltips
        3. Toolbar
        4. CPU Filtering
    5. Kernel Memory Usage
      1. Process Information
      2. Relative Kernel Memory Chart
        1. Using the mouse
        2. Tooltips
    6. Process Wait Analysis
      1. Prerequisites
      2. Running the analysis
    7. Input/Output Analysis
      1. Get the trace
      2. Input/Output Views
    8. LTTng Kernel Events Editor
  7. LTTng-UST Analyses
    1. Call Stack View
      1. Using the Callstack 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. Memory Usage
      1. Using the mouse
      2. Toolbar
    3. Source Lookup (for LTTng-UST 2.8+)
      1. Binary file location configuration
  8. Trace synchronization
    1. Obtain synchronizable traces
      1. LTTng-module network tracepoint with complete data
      2. 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. Virtual Machine Analysis
    1. Virtual Machine Experiment
    2. Virtual CPU View
      1. Using the keyboard
    3. Hypervisor-specific Tracing
      1. Qemu/KVM
  14. Limitations
  15. How to use LTTng to diagnose problems
    1. Random stutters
    2. Slow I/O
  16. References