RTI Connext Observability Framework Logo
7.1.0
  • 1. What is Connext Observability Framework?
    • 1.1. Telemetry Data
    • 1.2. Distribution of Telemetry Data
    • 1.3. Flexible Storage
    • 1.4. Visualization of Telemetry Data
    • 1.5. Control and Selection of Telemetry Data
  • 2. Components
    • 2.1. Observability Library
    • 2.2. Observability Collector Service
      • 2.2.1. Storage Components
    • 2.3. Observability Dashboards
    • 2.4. How We Provide the Components
      • 2.4.1. Observability Library
      • 2.4.2. Collection, Storage, and Visualization Components
        • 2.4.2.1. Current Release
        • 2.4.2.2. Future releases
  • 3. Deployment Scenarios
    • 3.1. Current Release
    • 3.2. Future Releases
  • 4. Installing and Running Observability Framework
    • 4.1. Installing the Target Package
      • 4.1.1. Install from RTI Launcher
      • 4.1.2. Install from the Command Line
    • 4.2. Installing the Host Package
      • 4.2.1. Prerequisites
      • 4.2.2. Install from RTI Launcher
      • 4.2.3. Install from the Command Line
    • 4.3. Configuring and Running Observability Framework Components
      • 4.3.1. Configure the Docker Workspace for Observability Framework
        • 4.3.1.1. Configuring Ports Used by Observability Components
      • 4.3.2. Initialize and Run Docker Containers
      • 4.3.3. Verify Docker Containers are Running
      • 4.3.4. Configure Grafana
        • 4.3.4.1. Initial Login
        • 4.3.4.2. Configuration Options
      • 4.3.5. Stop Docker Containers
      • 4.3.6. Start Existing Docker Containers
      • 4.3.7. Stop and Remove Docker Containers
  • 5. Getting Started Guide
    • 5.1. About the Observability Example
      • 5.1.1. Applications
      • 5.1.2. Data Model
      • 5.1.3. DDS Entity Mapping
      • 5.1.4. Command Line Parameters
        • 5.1.4.1. Publishing Application
        • 5.1.4.2. Subscribing Application
    • 5.2. Before Running the Example
      • 5.2.1. Install Observability Framework
      • 5.2.2. Set Up Environment Variables
      • 5.2.3. Compile the Example
        • 5.2.3.1. Non-Windows Systems
        • 5.2.3.2. Windows Systems
      • 5.2.4. Start the Collection, Storage, and Visualization Docker Containers
        • 5.2.4.1. Running on a LAN
        • 5.2.4.2. Running on a WAN
    • 5.3. Running the Example
      • 5.3.1. Start the Applications
      • 5.3.2. Changing the Time Range in Dashboards
      • 5.3.3. Simulate Sensor Failure
      • 5.3.4. Simulate Slow Sensor Data Consumption
      • 5.3.5. Simulate Time Synchronization Failures
      • 5.3.6. Change the Application Logging Verbosity
      • 5.3.7. Close the Applications
  • 6. Telemetry Data
    • 6.1. Introduction
    • 6.2. Resources
    • 6.3. Metrics
      • 6.3.1. Application Metrics
      • 6.3.2. Participant Metrics
      • 6.3.3. Topic Metrics
      • 6.3.4. DataWriter Metrics
      • 6.3.5. DataReader Metrics
      • 6.3.6. Derived Metrics Generated by Prometheus Recording Rules
        • 6.3.6.1. DDS Entity Proxy Metrics
        • 6.3.6.2. Raw Error Metrics
        • 6.3.6.3. Aggregated Error Metrics
        • 6.3.6.4. Enable a Raw Error Metric
        • 6.3.6.5. Custom Error Metrics
    • 6.4. Logs
  • 7. Observability Library
    • 7.1. Observability QoS Profile
  • 8. Troubleshooting Observability Framework
    • 8.1. Docker Container[s] Failed to Start
      • 8.1.1. Check for Port Conflicts
      • 8.1.2. Check that You Have the Correct File Permissions
    • 8.2. No Data in Dashboards
      • 8.2.1. Check that Collector Service has Discovered Your Applications
      • 8.2.2. Check that Prometheus can Access Collector Service
      • 8.2.3. Check that Grafana can Access Prometheus
  • 9. Glossary
  • 10. Release Notes
    • 10.1. Supported Platforms
    • 10.2. Supported Docker Compose Environments
    • 10.3. Compatibility
    • 10.4. What’s New in 7.1.0
    • 10.5. Third-Party Software
  • 11. Copyrights and Notices
RTI Connext Observability Framework
  • Search

© Copyright 2023, Real-Time Innovations, Inc.

Built with Sphinx using a theme provided by Read the Docs.