Observability Framework

• 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
  • 1.6. Security
• 2. Components
  • 2.1. Monitoring Library 2.0
  • 2.2. Observability Collector Service
    • 2.2.1. Storage Components
  • 2.3. Observability Dashboards
  • 2.4. How We Provide the Components
    • 2.4.1. Monitoring Library 2.0
    • 2.4.2. Collection, Storage, and Visualization Components
• 3. Deployments
  • 3.1. Collector Service Deployments
    • 3.1.1. Current Release
    • 3.1.2. Future Releases
• 4. Security
  • 4.1. Secure Communication between Connext Applications and Collector Service
  • 4.2. Secure Communication with Collector Service’s HTTP Servers
  • 4.3. Secure Communication with Third-party Components’ HTTP Servers
  • 4.4. Generating the Observability Framework Security Artifacts
    • 4.4.1. Generating DDS Security Artifacts
    • 4.4.2. Generating HTTPS Security Artifacts
• 5. Installing and Running Observability Framework
  • 5.1. Installing the Target Package
    • 5.1.1. Install from RTI Launcher
    • 5.1.2. Install from the Command Line
  • 5.2. Installing the Host Package
    • 5.2.1. Prerequisites
    • 5.2.2. Install from RTI Launcher
    • 5.2.3. Install from the Command Line
  • 5.3. Configuring, Running, and Removing Observability Framework Components Using Docker Compose
    • 5.3.1. Configuring the Docker Workspace for Observability Framework
    • 5.3.2. Initialize and Run Docker Containers
    • 5.3.3. Verify Docker Containers are Running
    • 5.3.4. Configure Grafana
    • 5.3.5. Stop Docker Containers
    • 5.3.6. Start Existing Docker Containers
    • 5.3.7. Stop and Remove Docker Containers
    • 5.3.8. Removing the Docker Workspace for Observability Framework
• 6. Getting Started Guide
  • 6.1. About the Observability Example
    • 6.1.1. Applications
    • 6.1.2. Data Model
    • 6.1.3. DDS Entity Mapping
    • 6.1.4. Command Line Parameters
  • 6.2. Before Running the Example
    • 6.2.1. Set Up Environment Variables
    • 6.2.2. Compile the Example
    • 6.2.3. Install Observability Framework
    • 6.2.4. Start the Collection, Storage, and Visualization Docker Containers
  • 6.3. Running the Example
    • 6.3.1. Start the Applications
    • 6.3.2. Changing the Time Range in Dashboards
    • 6.3.3. Simulate Sensor Failure
    • 6.3.4. Simulate Slow Sensor Data Consumption
    • 6.3.5. Simulate Time Synchronization Failures
    • 6.3.6. Change the Application Logging Verbosity
    • 6.3.7. Close the Applications
• 7. Telemetry Data
  • 7.1. Introduction
  • 7.2. Resources
  • 7.3. Metrics
    • 7.3.1. Application Metrics
    • 7.3.2. Participant Metrics
    • 7.3.3. Topic Metrics
    • 7.3.4. DataWriter Metrics
    • 7.3.5. DataReader Metrics
    • 7.3.6. Derived Metrics Generated by Prometheus Recording Rules
  • 7.4. Logs
    • 7.4.1. Collection and Forwarding Verbosity
• 8. Monitoring Library 2.0
  • 8.1. Enabling Monitoring Library 2.0
  • 8.2. Setting the Application Name
  • 8.3. Changing the Default Observability Domain ID
  • 8.4. Configuring QoS for Monitoring Library 2.0 Entities
  • 8.5. Setting Collector Service Initial Peers
• 9. Troubleshooting Observability Framework
  • 9.1. Docker Container[s] Failed to Start
    • 9.1.1. Check for Port Conflicts
    • 9.1.2. Check that You Have the Correct File Permissions
  • 9.2. No Data in Dashboards
    • 9.2.1. Check that Collector Service has Discovered Your Applications
    • 9.2.2. Check that Prometheus can Access Collector Service
    • 9.2.3. Check that Grafana can Access Prometheus
• 10. Glossary
• 11. Release Notes
  • 11.1. Supported Platforms
  • 11.2. Compatibility
  • 11.3. Supported Docker Compose Environments
  • 11.4. What’s New in 7.2.0
    • 11.4.1. Observability Collector Service compatible with Monitoring Library 2.0
    • 11.4.2. Support for most observability backends with OpenTelemetry integration
    • 11.4.3. Support for RTI Observability Collector Service security
    • 11.4.4. Name change from “RTI Observability Library” to “RTI Monitoring Library 2.0”
    • 11.4.5. Name change for some Observability metrics
    • 11.4.6. Secured communications between RTI Monitoring Library 2.0 and RTI Observability Collector Service
    • 11.4.7. Ability to set initial forwarding verbosity in MONITORING QoS policy
    • 11.4.8. Ability to set collector initial peers in MONITORING QoS policy
    • 11.4.9. Third-Party software changes
  • 11.5. What’s Fixed in 7.2.0
    • 11.5.1. Collector Service might have crashed on startup
    • 11.5.2. Controllability issues on applications with same name
    • 11.5.3. Unhandled exceptions may have caused segmentation fault
    • 11.5.4. Race condition when processing remote commands led to failures and memory leaks when shutting down Collector Service
    • 11.5.5. Observability Collector Service could discard samples when monitoring large DDS applications
  • 11.6. Previous Release
    • 11.6.1. What’s New in 7.1.0
• 12. Copyrights and Notices