.. include:: /../getting_started/vars.rst


*Connext Observability Framework* uses telemetry data to help identify and 
resolve potential issues in |Connext| applications. This product is not
installed as part of a |Connext| package; it must be downloaded and
installed separately, as described in :ref:`section-installation`.

.. important:: 

   *Observability Framework* is an experimental product that includes example 
   configuration files for use with several third-party components (Prometheus,
   Grafana Loki, and Grafana). This release is an evaluation distribution; 
   use it to explore the new observability features that support |Connext| 
   applications. 

   Do not deploy any *Observability Framework* components in production.


Supported Platforms
===================

The components of *RTI Connext Observability Framework* are supported on 
the following platforms: 

* *RTI Observability Collector Service* is supported as a Docker image on
  linux/amd64 (x64Linux).

* *RTI Monitoring Library 2.0* is supported on all supported platforms in
  this release. See :link_connext_dds_pro_rn:`Supported Platforms <pam_table.html>`
  in the *RTI Connext Core Libraries Release Notes*.

Compatibility
=============

*Connext Observability Framework* is an optional product released 
with *RTI Connext* 7.2.0. 

The current *Observability Framework* release is not compatible with 
*Connext* 7.1.0. This release works only with *Connext* 7.2.0.


.. _section-docker-compose-env:

Supported Docker Compose Environments
=====================================

The *Observability Framework* package enables you to deploy and run 
*Observability Collector Service* and third-party components NGINX, 
OpenTelemetry Collector, Prometheus, Grafana Loki, and Grafana, using 
Docker Compose in a single Linux host. The host can run on a Virtual Machine 
(VM); in this release, we have tested the following combinations:

.. list-table:: Tested VM/OS Combinations
    :name: Tested VMs
    :widths: 60 60 60
    :header-rows: 1

    * - Host Architecture/OS
      - VM Architecture/OS
      - VM
    * - x86 Windows
      - x86 Ubuntu
      - VirtualBox
    * - x86 Mac
      - x86 Ubuntu
      - Parallels
    * - x86 Ubuntu
      - None
      - None

.. important::
    The Docker Compose distribution uses “host” networking that only works 
    on Linux hosts; it is not supported on Docker Desktop for Mac, Docker 
    Desktop for Windows, or Docker EE for Windows Server. 
    
    Windows virtualization technologies such as WSL, WSL2, and Hyper-V also do
    not support “host” networking. Running *Observability Framework* using  
    Docker Compose in these environments will not work.